-
Notifications
You must be signed in to change notification settings - Fork 46
Expand file tree
/
Copy pathprovider_tracking.cpp
More file actions
373 lines (288 loc) · 11.9 KB
/
Copy pathprovider_tracking.cpp
File metadata and controls
373 lines (288 loc) · 11.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
// Copyright (C) 2025 Intel Corporation
// Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include <umf/memory_provider.h>
#include <umf/pools/pool_proxy.h>
#include <umf/providers/provider_fixed_memory.h>
#include "base.hpp"
#include "provider.hpp"
#include "test_helpers.h"
#include "utils/cpp_helpers.hpp"
#ifndef _WIN32
#include "test_helpers_linux.h"
#endif
using umf_test::test;
#define FIXED_BUFFER_SIZE (512 * utils_get_page_size())
#define INVALID_PTR ((void *)0x01)
struct TrackingProviderTest
: umf_test::test,
::testing::WithParamInterface<providerCreateExtParams> {
void SetUp() override {
test::SetUp();
// Allocate a memory buffer to use with the fixed memory provider
memory_size = FIXED_BUFFER_SIZE;
memory_buffer = malloc(memory_size);
ASSERT_NE(memory_buffer, nullptr);
// Create provider parameters
umf_fixed_memory_provider_params_handle_t params = nullptr;
umf_result_t res = umfFixedMemoryProviderParamsCreate(
memory_buffer, memory_size, ¶ms);
ASSERT_EQ(res, UMF_RESULT_SUCCESS);
ASSERT_NE(params, nullptr);
providerCreateExt(std::make_tuple(umfFixedMemoryProviderOps(), params),
&provider);
umfFixedMemoryProviderParamsDestroy(params);
umf_result_t umf_result =
umfMemoryProviderGetMinPageSize(provider.get(), NULL, &page_size);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
page_plus_64 = page_size + 64;
umf_memory_pool_handle_t hPool = nullptr;
umf_result = umfPoolCreate(umfProxyPoolOps(), provider.get(), nullptr,
0, &hPool);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
pool = umf_test::pool_unique_handle_t(hPool, &umfPoolDestroy);
}
void TearDown() override {
if (memory_buffer) {
free(memory_buffer);
memory_buffer = nullptr;
}
test::TearDown();
}
umf_test::provider_unique_handle_t provider;
umf_test::pool_unique_handle_t pool;
size_t page_size;
size_t page_plus_64;
void *memory_buffer = nullptr;
size_t memory_size = 0;
};
static void
createPoolFromAllocation(void *ptr0, size_t size1,
umf_memory_provider_handle_t *_providerFromPtr,
umf_memory_pool_handle_t *_poolFromPtr) {
umf_result_t umf_result;
// Create provider parameters
umf_fixed_memory_provider_params_handle_t params = nullptr;
umf_result = umfFixedMemoryProviderParamsCreate(ptr0, size1, ¶ms);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
ASSERT_NE(params, nullptr);
umf_memory_provider_handle_t provider1 = nullptr;
umf_result = umfMemoryProviderCreate(umfFixedMemoryProviderOps(), params,
&provider1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
ASSERT_NE(provider1, nullptr);
umf_memory_pool_handle_t pool1 = nullptr;
umf_result =
umfPoolCreate(umfProxyPoolOps(), provider1, nullptr, 0, &pool1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umfFixedMemoryProviderParamsDestroy(params);
*_providerFromPtr = provider1;
*_poolFromPtr = pool1;
}
// TESTS
INSTANTIATE_TEST_SUITE_P(trackingProviderTest, TrackingProviderTest,
::testing::Values(providerCreateExtParams{
umfFixedMemoryProviderOps(), nullptr}),
providerCreateExtParamsNameGen);
TEST_P(TrackingProviderTest, create_destroy) {
// Creation and destruction are handled in SetUp and TearDown
}
TEST_P(TrackingProviderTest, whole_size_success) {
umf_result_t umf_result;
size_t size0;
size_t size1;
void *ptr0 = nullptr;
void *ptr1 = nullptr;
umf_memory_pool_handle_t pool0 = pool.get();
size0 = FIXED_BUFFER_SIZE - (2 * page_size);
ptr0 = umfPoolAlignedMalloc(pool0, size0, utils_get_page_size());
ASSERT_NE(ptr0, nullptr);
size1 = size0; // whole size
umf_memory_provider_handle_t provider1 = nullptr;
umf_memory_pool_handle_t pool1 = nullptr;
createPoolFromAllocation(ptr0, size1, &provider1, &pool1);
ptr1 = umfPoolMalloc(pool1, size1);
ASSERT_NE(ptr1, nullptr);
umf_result = umfPoolFree(pool1, ptr1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfPoolDestroy(pool1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfMemoryProviderDestroy(provider1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfPoolFree(pool0, ptr0);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
}
TEST_P(TrackingProviderTest, half_size_success) {
umf_result_t umf_result;
size_t size0;
size_t size1;
void *ptr0 = nullptr;
void *ptr1 = nullptr;
umf_memory_pool_handle_t pool0 = pool.get();
size0 = FIXED_BUFFER_SIZE - (2 * page_size);
ptr0 = umfPoolAlignedMalloc(pool0, size0, utils_get_page_size());
ASSERT_NE(ptr0, nullptr);
size1 = size0 / 2; // half size
umf_memory_provider_handle_t provider1 = nullptr;
umf_memory_pool_handle_t pool1 = nullptr;
createPoolFromAllocation(ptr0, size1, &provider1, &pool1);
ptr1 = umfPoolMalloc(pool1, size1);
ASSERT_NE(ptr1, nullptr);
umf_result = umfPoolFree(pool1, ptr1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfPoolDestroy(pool1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfMemoryProviderDestroy(provider1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfPoolFree(pool0, ptr0);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
}
TEST_P(TrackingProviderTest, failure_exceeding_size) {
umf_result_t umf_result;
size_t size0;
size_t size1;
void *ptr0 = nullptr;
void *ptr1 = nullptr;
umf_memory_pool_handle_t pool0 = pool.get();
size0 = FIXED_BUFFER_SIZE - (2 * page_size);
ptr0 = umfPoolAlignedMalloc(pool0, size0, utils_get_page_size());
ASSERT_NE(ptr0, nullptr);
size1 = FIXED_BUFFER_SIZE - page_size; // exceeding size
umf_memory_provider_handle_t provider1 = nullptr;
umf_memory_pool_handle_t pool1 = nullptr;
createPoolFromAllocation(ptr0, size1, &provider1, &pool1);
ptr1 = umfPoolMalloc(pool1, size1);
ASSERT_EQ(ptr1, nullptr);
umf_result = umfPoolDestroy(pool1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfMemoryProviderDestroy(provider1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfPoolFree(pool0, ptr0);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
}
#define MAX_ARRAY 9
#define TEST_LEVEL_SUCCESS 7
#define TEST_LEVEL_FAILURE 8
TEST_P(TrackingProviderTest, success_max_levels) {
umf_result_t umf_result;
size_t size;
void *ptr[MAX_ARRAY] = {0};
umf_memory_provider_handle_t providers[MAX_ARRAY] = {0};
umf_memory_pool_handle_t pools[MAX_ARRAY] = {0};
size = FIXED_BUFFER_SIZE - (2 * page_size);
pools[0] = pool.get();
for (int i = 0; i < TEST_LEVEL_SUCCESS; i++) {
fprintf(stderr, "Alloc #%d\n", i);
ptr[i] = umfPoolAlignedMalloc(pools[i], size, utils_get_page_size());
ASSERT_NE(ptr[i], nullptr);
createPoolFromAllocation(ptr[i], size, &providers[i + 1],
&pools[i + 1]);
}
int s = TEST_LEVEL_SUCCESS;
fprintf(stderr, "Alloc #%d\n", s);
ptr[s] = umfPoolAlignedMalloc(pools[s], size, utils_get_page_size());
ASSERT_NE(ptr[s], nullptr);
fprintf(stderr, "Free #%d\n", s);
umf_result = umfPoolFree(pools[s], ptr[s]);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
for (int i = TEST_LEVEL_SUCCESS - 1; i >= 0; i--) {
umf_result = umfPoolDestroy(pools[i + 1]);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfMemoryProviderDestroy(providers[i + 1]);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
fprintf(stderr, "Free #%d\n", i);
umf_result = umfPoolFree(pools[i], ptr[i]);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
}
}
TEST_P(TrackingProviderTest, failure_exceeding_levels) {
umf_result_t umf_result;
size_t size;
void *ptr[MAX_ARRAY] = {0};
umf_memory_provider_handle_t providers[MAX_ARRAY] = {0};
umf_memory_pool_handle_t pools[MAX_ARRAY] = {0};
size = FIXED_BUFFER_SIZE - (2 * page_size);
pools[0] = pool.get();
for (int i = 0; i < TEST_LEVEL_FAILURE; i++) {
fprintf(stderr, "Alloc #%d\n", i);
ptr[i] = umfPoolAlignedMalloc(pools[i], size, utils_get_page_size());
ASSERT_NE(ptr[i], nullptr);
createPoolFromAllocation(ptr[i], size, &providers[i + 1],
&pools[i + 1]);
}
// tracker level is too high
int f = TEST_LEVEL_FAILURE;
fprintf(stderr, "Alloc #%d\n", f);
ptr[f] = umfPoolAlignedMalloc(pools[f], size, utils_get_page_size());
ASSERT_EQ(ptr[f], nullptr);
for (int i = TEST_LEVEL_FAILURE - 1; i >= 0; i--) {
umf_result = umfPoolDestroy(pools[i + 1]);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfMemoryProviderDestroy(providers[i + 1]);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
fprintf(stderr, "Free #%d\n", i);
umf_result = umfPoolFree(pools[i], ptr[i]);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
}
}
TEST_P(TrackingProviderTest, reverted_free_half_size) {
umf_result_t umf_result;
size_t size0;
size_t size1;
void *ptr0 = nullptr;
void *ptr1 = nullptr;
umf_memory_pool_handle_t pool0 = pool.get();
size0 = FIXED_BUFFER_SIZE - (2 * page_size);
ptr0 = umfPoolAlignedMalloc(pool0, size0, utils_get_page_size());
ASSERT_NE(ptr0, nullptr);
umf_memory_provider_handle_t provider1 = nullptr;
umf_memory_pool_handle_t pool1 = nullptr;
createPoolFromAllocation(ptr0, size0, &provider1, &pool1);
size1 = size0 / 2; // half size
ptr1 = umfPoolMalloc(pool1, size1);
ASSERT_NE(ptr1, nullptr);
// Freeing the "busy" pointer from the first pool is an Undefined Behavior
// It fails now if the sizes are different.
// see: https://github.com/oneapi-src/unified-memory-framework/pull/1161
umf_result = umfPoolFree(pool0, ptr0);
umf_result = umfPoolFree(pool1, ptr1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfPoolDestroy(pool1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfMemoryProviderDestroy(provider1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
// It could have been freed above,
// so we cannot verify the result here.
umf_result = umfPoolFree(pool0, ptr0);
}
TEST_P(TrackingProviderTest, reverted_free_the_same_size) {
umf_result_t umf_result;
size_t size0;
size_t size1;
void *ptr0 = nullptr;
void *ptr1 = nullptr;
umf_memory_pool_handle_t pool0 = pool.get();
size0 = FIXED_BUFFER_SIZE - (2 * page_size);
ptr0 = umfPoolAlignedMalloc(pool0, size0, utils_get_page_size());
ASSERT_NE(ptr0, nullptr);
umf_memory_provider_handle_t provider1 = nullptr;
umf_memory_pool_handle_t pool1 = nullptr;
createPoolFromAllocation(ptr0, size0, &provider1, &pool1);
size1 = size0; // the same size
ptr1 = umfPoolMalloc(pool1, size1);
ASSERT_NE(ptr1, nullptr);
// Freeing the "busy" pointer from the first pool is an Undefined Behavior
// It succeeds now if the sizes are equal.
// see: https://github.com/oneapi-src/unified-memory-framework/pull/1161
umf_result = umfPoolFree(pool0, ptr0);
// try to free the pointer from the second pool (the same size)
umf_result = umfPoolFree(pool1, ptr1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfPoolDestroy(pool1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
umf_result = umfMemoryProviderDestroy(provider1);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
// It could have been freed above,
// so we cannot verify the result here.
umf_result = umfPoolFree(pool0, ptr0);
}