Skip to content

Commit f8255ba

Browse files
ldorauldorau
committed
Add tests for the size threshold of the proxy library
The proxyLib_size_threshold_* tests test the size threshold of the proxy library. The size threshold is set to 64 bytes in this test, so all allocations of: 1) size < 64 go through the default system allocator and (umfPoolByPtr(ptr_size < 64) == nullptr) 2) size >= 64 go through the proxy lib allocator and (umfPoolByPtr(ptr_size >= 64) != nullptr). Ref: oneapi-src#894 Signed-off-by: Lukasz Dorau <lukasz.dorau@intel.com>
1 parent 1abc22e commit f8255ba

File tree

3 files changed

+150
-30
lines changed

3 files changed

+150
-30
lines changed

‎.github/workflows/reusable_proxy_lib.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,14 @@ jobs:
6161

6262
# TODO enable the provider_file_memory_ipc test when the IPC tests with the proxy library are fixed
6363
# see the issue: https://github.com/oneapi-src/unified-memory-framework/issues/864
64+
# TODO enable the proxy_lib_basic test for the JEMALLOC proxy_lib_pool
65+
# see the issue: https://github.com/oneapi-src/unified-memory-framework/issues/894
6466
- name: Run "ctest --output-on-failure" with proxy library
6567
working-directory: ${{env.BUILD_DIR}}
66-
run: LD_PRELOAD=./lib/libumf_proxy.so ctest --output-on-failure -E provider_file_memory_ipc
68+
run: >
69+
LD_PRELOAD=./lib/libumf_proxy.so
70+
ctest --output-on-failure
71+
${{ matrix.proxy_lib_pool == 'JEMALLOC' && '-E "provider_file_memory_ipc|proxy_lib_basic"' || '-E provider_file_memory_ipc' }}
6772
6873
- name: Run "./test/umf_test-memoryPool" with proxy library
6974
working-directory: ${{env.BUILD_DIR}}
@@ -79,13 +84,16 @@ jobs:
7984

8085
# TODO enable the provider_file_memory_ipc test when the IPC tests with the proxy library are fixed
8186
# see the issue: https://github.com/oneapi-src/unified-memory-framework/issues/864
87+
# TODO enable the proxy_lib_basic test for the JEMALLOC proxy_lib_pool
88+
# see the issue: https://github.com/oneapi-src/unified-memory-framework/issues/894
8289
- name: Run "ctest --output-on-failure" with proxy library and size.threshold=128
8390
working-directory: ${{env.BUILD_DIR}}
8491
run: >
8592
UMF_PROXY="size.threshold=128"
8693
UMF_LOG="level:debug;flush:debug;output:stderr;pid:yes"
8794
LD_PRELOAD=./lib/libumf_proxy.so
88-
ctest --output-on-failure -E provider_file_memory_ipc
95+
ctest --output-on-failure
96+
${{ matrix.proxy_lib_pool == 'JEMALLOC' && '-E "provider_file_memory_ipc|proxy_lib_basic"' || '-E provider_file_memory_ipc' }}
8997
9098
- name: Check coverage
9199
if: ${{ matrix.build_type == 'Debug' }}

‎test/CMakeLists.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,11 @@ if(UMF_PROXY_LIB_ENABLED AND UMF_BUILD_SHARED_LIBRARY)
413413
NAME proxy_lib_basic
414414
SRCS ${BA_SOURCES_FOR_TEST} test_proxy_lib.cpp
415415
LIBS ${UMF_UTILS_FOR_TEST} umf_proxy)
416+
# TODO enable it on Windows
417+
if(LINUX)
418+
set_property(TEST umf-proxy_lib_basic
419+
PROPERTY ENVIRONMENT "UMF_PROXY=size.threshold=64")
420+
endif()
416421

417422
# the memoryPool test run with the proxy library
418423
add_umf_test(

‎test/test_proxy_lib.cpp

Lines changed: 135 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@
1919

2020
using umf_test::test;
2121

22-
#define SIZE_64 64
22+
// size threshold defined by the env variable UMF_PROXY="size.threshold=64"
23+
#define SIZE_THRESHOLD 64
24+
#define SIZE_EQ (SIZE_THRESHOLD)
25+
#define SIZE_LT (SIZE_THRESHOLD - 1)
26+
2327
#define ALIGN_1024 1024
2428

2529
TEST_F(test, proxyLib_basic) {
26-
27-
::free(::malloc(SIZE_64));
28-
2930
// a check to verify we are running the proxy library
3031
void *ptr = (void *)0x01;
3132

@@ -41,46 +42,152 @@ TEST_F(test, proxyLib_basic) {
4142
}
4243

4344
TEST_F(test, proxyLib_realloc_size0) {
44-
// realloc(ptr, 0) == free (ptr)
45+
// realloc(ptr, 0) == free(ptr)
4546
// realloc(ptr, 0) returns NULL
46-
ASSERT_EQ(::realloc(::malloc(SIZE_64), 0), nullptr);
47+
ASSERT_EQ(::realloc(::malloc(SIZE_EQ), 0), nullptr);
4748
}
4849

49-
TEST_F(test, proxyLib_malloc_usable_size) {
50-
51-
void *ptr = ::malloc(SIZE_64);
52-
ASSERT_NE(ptr, nullptr);
53-
if (ptr == nullptr) {
54-
// Fix for the following CodeQL's warning on Windows:
55-
// 'ptr' could be '0': this does not adhere to the specification for the function '_msize'.
56-
return;
57-
}
50+
// The proxyLib_size_threshold_* tests test the size threshold of the proxy library.
51+
// The size threshold is set to SIZE_THRESHOLD bytes in this test, so all allocations of:
52+
// 1) size < SIZE_THRESHOLD go through the default system allocator
53+
// (umfPoolByPtr(ptr_size < SIZE_THRESHOLD) == nullptr)
54+
// 2) size >= SIZE_THRESHOLD go through the proxy library allocator
55+
// (umfPoolByPtr(ptr_size >= SIZE_THRESHOLD) != nullptr)
5856

57+
TEST_F(test, proxyLib_size_threshold_aligned_alloc) {
5958
#ifdef _WIN32
60-
size_t size = _msize(ptr);
61-
#elif __APPLE__
62-
size_t size = ::malloc_size(ptr);
59+
void *ptr_LT = _aligned_malloc(SIZE_LT, ALIGN_1024);
60+
void *ptr_EQ = _aligned_malloc(SIZE_EQ, ALIGN_1024);
6361
#else
64-
size_t size = ::malloc_usable_size(ptr);
62+
void *ptr_LT = ::aligned_alloc(ALIGN_1024, SIZE_LT);
63+
void *ptr_EQ = ::aligned_alloc(ALIGN_1024, SIZE_EQ);
6564
#endif
6665

67-
ASSERT_EQ((int)(size == 0 || size >= SIZE_64), 1);
66+
ASSERT_NE(ptr_LT, nullptr);
67+
ASSERT_NE(ptr_EQ, nullptr);
6868

69-
::free(ptr);
70-
}
69+
// verify alignment
70+
ASSERT_EQ((int)(IS_ALIGNED((uintptr_t)ptr_LT, ALIGN_1024)), 1);
71+
ASSERT_EQ((int)(IS_ALIGNED((uintptr_t)ptr_EQ, ALIGN_1024)), 1);
72+
73+
// umfPoolByPtr(ptr_size_LT) == nullptr
74+
ASSERT_EQ(umfPoolByPtr(ptr_LT), nullptr);
75+
// umfPoolByPtr(ptr_size_EQ) != nullptr
76+
ASSERT_NE(umfPoolByPtr(ptr_EQ), nullptr);
7177

72-
TEST_F(test, proxyLib_aligned_alloc) {
7378
#ifdef _WIN32
74-
void *ptr = _aligned_malloc(SIZE_64, ALIGN_1024);
79+
_aligned_free(ptr_LT);
80+
_aligned_free(ptr_EQ);
7581
#else
76-
void *ptr = ::aligned_alloc(ALIGN_1024, SIZE_64);
82+
::free(ptr_LT);
83+
::free(ptr_EQ);
7784
#endif
85+
}
86+
87+
TEST_F(test, proxyLib_size_threshold_malloc) {
88+
void *ptr_LT = malloc(SIZE_LT);
89+
void *ptr_EQ = malloc(SIZE_EQ);
90+
91+
ASSERT_NE(ptr_LT, nullptr);
92+
ASSERT_NE(ptr_EQ, nullptr);
93+
94+
// umfPoolByPtr(ptr_size_LT) == nullptr
95+
ASSERT_EQ(umfPoolByPtr(ptr_LT), nullptr);
96+
// umfPoolByPtr(ptr_size_EQ) != nullptr
97+
ASSERT_NE(umfPoolByPtr(ptr_EQ), nullptr);
98+
99+
::free(ptr_LT);
100+
::free(ptr_EQ);
101+
}
102+
103+
TEST_F(test, proxyLib_size_threshold_calloc) {
104+
void *ptr_LT = calloc(SIZE_LT, 1);
105+
void *ptr_EQ = calloc(SIZE_EQ, 1);
106+
107+
ASSERT_NE(ptr_LT, nullptr);
108+
ASSERT_NE(ptr_EQ, nullptr);
109+
110+
// umfPoolByPtr(ptr_size_LT) == nullptr
111+
ASSERT_EQ(umfPoolByPtr(ptr_LT), nullptr);
112+
// umfPoolByPtr(ptr_size_EQ) != nullptr
113+
ASSERT_NE(umfPoolByPtr(ptr_EQ), nullptr);
114+
115+
::free(ptr_LT);
116+
::free(ptr_EQ);
117+
}
78118

79-
ASSERT_EQ((int)(IS_ALIGNED((uintptr_t)ptr, ALIGN_1024)), 1);
119+
TEST_F(test, proxyLib_size_threshold_realloc_up) {
120+
void *ptr_LT = malloc(SIZE_LT);
121+
void *ptr_EQ = malloc(SIZE_EQ);
122+
123+
ASSERT_NE(ptr_LT, nullptr);
124+
ASSERT_NE(ptr_EQ, nullptr);
125+
126+
ptr_LT = realloc(ptr_LT, 2 * SIZE_LT);
127+
ptr_EQ = realloc(ptr_EQ, 2 * SIZE_EQ);
128+
129+
ASSERT_NE(ptr_LT, nullptr);
130+
ASSERT_NE(ptr_EQ, nullptr);
131+
132+
// umfPoolByPtr(ptr_size_LT) == nullptr
133+
ASSERT_EQ(umfPoolByPtr(ptr_LT), nullptr);
134+
// umfPoolByPtr(ptr_size_EQ) != nullptr
135+
ASSERT_NE(umfPoolByPtr(ptr_EQ), nullptr);
136+
137+
::free(ptr_LT);
138+
::free(ptr_EQ);
139+
}
140+
141+
TEST_F(test, proxyLib_size_threshold_realloc_down) {
142+
void *ptr_LT = malloc(SIZE_LT);
143+
void *ptr_EQ = malloc(SIZE_EQ);
144+
145+
ASSERT_NE(ptr_LT, nullptr);
146+
ASSERT_NE(ptr_EQ, nullptr);
147+
148+
ptr_LT = realloc(ptr_LT, SIZE_LT / 2);
149+
ptr_EQ = realloc(ptr_EQ, SIZE_EQ / 2);
150+
151+
ASSERT_NE(ptr_LT, nullptr);
152+
ASSERT_NE(ptr_EQ, nullptr);
153+
154+
// umfPoolByPtr(ptr_size_LT) == nullptr
155+
ASSERT_EQ(umfPoolByPtr(ptr_LT), nullptr);
156+
// umfPoolByPtr(ptr_size_EQ) != nullptr
157+
ASSERT_NE(umfPoolByPtr(ptr_EQ), nullptr);
158+
159+
::free(ptr_LT);
160+
::free(ptr_EQ);
161+
}
162+
163+
TEST_F(test, proxyLib_size_threshold_malloc_usable_size) {
164+
165+
void *ptr_LT = ::malloc(SIZE_LT);
166+
void *ptr_EQ = ::malloc(SIZE_EQ);
167+
168+
ASSERT_NE(ptr_LT, nullptr);
169+
ASSERT_NE(ptr_EQ, nullptr);
170+
171+
if (ptr_LT == nullptr || ptr_EQ == nullptr) {
172+
// Fix for the following CodeQL's warning on Windows:
173+
// 'ptr' could be '0': this does not adhere to the specification for the function '_msize'.
174+
return;
175+
}
80176

81177
#ifdef _WIN32
82-
_aligned_free(ptr);
178+
size_t size_LT = _msize(ptr_LT);
179+
size_t size_EQ = _msize(ptr_EQ);
180+
#elif __APPLE__
181+
size_t size_LT = ::malloc_size(ptr_LT);
182+
size_t size_EQ = ::malloc_size(ptr_EQ);
83183
#else
84-
::free(ptr);
184+
size_t size_LT = ::malloc_usable_size(ptr_LT);
185+
size_t size_EQ = ::malloc_usable_size(ptr_EQ);
85186
#endif
187+
188+
ASSERT_EQ((int)(size_LT == 0 || size_LT >= SIZE_LT), 1);
189+
ASSERT_EQ((int)(size_EQ == 0 || size_EQ >= SIZE_EQ), 1);
190+
191+
::free(ptr_LT);
192+
::free(ptr_EQ);
86193
}

0 commit comments

Comments
 (0)