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
|
/*
* Copyright (C) 2018-2022 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#include "shared/source/command_stream/command_stream_receiver.h"
#include "shared/source/device/device.h"
#include "shared/source/memory_manager/deferrable_allocation_deletion.h"
#include "shared/source/memory_manager/deferred_deleter.h"
#include "shared/source/os_interface/os_context.h"
#include "shared/test/common/libult/ult_command_stream_receiver.h"
#include "shared/test/common/mocks/mock_allocation_properties.h"
#include "shared/test/common/mocks/mock_device.h"
#include "shared/test/common/mocks/mock_memory_manager.h"
#include "shared/test/common/test_macros/hw_test.h"
using namespace NEO;
struct DeferredDeleterPublic : DeferredDeleter {
public:
using DeferredDeleter::doWorkInBackground;
using DeferredDeleter::queue;
using DeferredDeleter::queueMutex;
bool shouldStopReached = false;
bool allowExit = false;
bool shouldStop() override {
if (allowExit) {
EXPECT_TRUE(queue.peekIsEmpty());
}
shouldStopReached = allowExit;
return allowExit;
}
};
struct DeferrableAllocationDeletionTest : ::testing::Test {
void SetUp() override {
executionEnvironment = new MockExecutionEnvironment(defaultHwInfo.get(), false, 1u);
executionEnvironment->incRefInternal();
memoryManager = new MockMemoryManager(*executionEnvironment);
executionEnvironment->memoryManager.reset(memoryManager);
device.reset(Device::create<MockDevice>(executionEnvironment, 0u));
hwTag = device->getDefaultEngine().commandStreamReceiver->getTagAddress();
defaultOsContextId = device->getDefaultEngine().osContext->getContextId();
asyncDeleter = std::make_unique<DeferredDeleterPublic>();
asyncDeleter->addClient();
}
void TearDown() override {
asyncDeleter->allowExit = true;
asyncDeleter->removeClient();
executionEnvironment->decRefInternal();
}
ExecutionEnvironment *executionEnvironment;
std::unique_ptr<DeferredDeleterPublic> asyncDeleter;
MockMemoryManager *memoryManager = nullptr;
std::unique_ptr<MockDevice> device;
uint32_t defaultOsContextId = 0;
volatile uint32_t *hwTag = nullptr;
};
TEST_F(DeferrableAllocationDeletionTest, givenDeferrableAllocationWhenApplyThenWaitForEachTaskCount) {
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
allocation->updateTaskCount(1u, defaultOsContextId);
*hwTag = 0u;
asyncDeleter->deferDeletion(new DeferrableAllocationDeletion(*memoryManager, *allocation));
while (!asyncDeleter->queue.peekIsEmpty()) // wait for async thread to get allocation from queue
std::this_thread::yield();
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
EXPECT_TRUE(allocation->isUsedByOsContext(defaultOsContextId));
// let async thread exit
asyncDeleter->allowExit = true;
*hwTag = 1u; // allow to destroy allocation
while (!asyncDeleter->shouldStopReached)
std::this_thread::yield();
EXPECT_EQ(1u, memoryManager->freeGraphicsMemoryCalled);
}
HWTEST_F(DeferrableAllocationDeletionTest, givenDeferrableAllocationDeletionWhenTaskCountAlreadyFlushedThenDoNotProgrammTagUpdate) {
struct DeferrableAllocationDeletionApplyCall : public DeferrableAllocationDeletion {
using DeferrableAllocationDeletion::DeferrableAllocationDeletion;
bool apply() override {
auto ret = DeferrableAllocationDeletion::apply();
applyCalled = true;
return ret;
}
bool applyCalled = false;
};
auto &nonDefaultCommandStreamReceiver = static_cast<UltCommandStreamReceiver<FamilyType> &>(*device->commandStreamReceivers[1]);
auto nonDefaultOsContextId = nonDefaultCommandStreamReceiver.getOsContext().getContextId();
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
*hwTag = 0u;
*nonDefaultCommandStreamReceiver.getTagAddress() = 0u;
nonDefaultCommandStreamReceiver.setLatestFlushedTaskCount(2u);
static_cast<UltCommandStreamReceiver<FamilyType> *>(device->getDefaultEngine().commandStreamReceiver)->setLatestFlushedTaskCount(2u);
nonDefaultCommandStreamReceiver.taskCount = 2u;
static_cast<UltCommandStreamReceiver<FamilyType> *>(device->getDefaultEngine().commandStreamReceiver)->taskCount = 2u;
allocation->updateTaskCount(1u, nonDefaultOsContextId);
allocation->updateTaskCount(1u, defaultOsContextId);
auto used = nonDefaultCommandStreamReceiver.getCS(0u).getUsed();
EXPECT_FALSE(nonDefaultCommandStreamReceiver.flushBatchedSubmissionsCalled);
auto usedDefault = device->getDefaultEngine().commandStreamReceiver->getCS(0u).getUsed();
EXPECT_FALSE(static_cast<UltCommandStreamReceiver<FamilyType> *>(device->getDefaultEngine().commandStreamReceiver)->flushBatchedSubmissionsCalled);
auto deferrableAlloc = new DeferrableAllocationDeletionApplyCall(*memoryManager, *allocation);
EXPECT_FALSE(deferrableAlloc->applyCalled);
asyncDeleter->deferDeletion(deferrableAlloc);
while (!deferrableAlloc->applyCalled)
std::this_thread::yield();
*hwTag = 2u;
*nonDefaultCommandStreamReceiver.getTagAddress() = 2u;
EXPECT_FALSE(nonDefaultCommandStreamReceiver.flushBatchedSubmissionsCalled);
EXPECT_EQ(used, nonDefaultCommandStreamReceiver.getCS(0u).getUsed());
EXPECT_FALSE(static_cast<UltCommandStreamReceiver<FamilyType> *>(device->getDefaultEngine().commandStreamReceiver)->flushBatchedSubmissionsCalled);
EXPECT_EQ(usedDefault, device->getDefaultEngine().commandStreamReceiver->getCS(0u).getUsed());
asyncDeleter->allowExit = true;
*hwTag = 2u;
*nonDefaultCommandStreamReceiver.getTagAddress() = 2u;
}
HWTEST_F(DeferrableAllocationDeletionTest, givenAllocationUsedByTwoOsContextsWhenApplyDeletionThenWaitForBothContextsAndFlushNotReadyCsr) {
auto &nonDefaultCommandStreamReceiver = static_cast<UltCommandStreamReceiver<FamilyType> &>(*device->commandStreamReceivers[1]);
auto nonDefaultOsContextId = nonDefaultCommandStreamReceiver.getOsContext().getContextId();
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
*hwTag = 0u;
*nonDefaultCommandStreamReceiver.getTagAddress() = 1u;
allocation->updateTaskCount(1u, defaultOsContextId);
allocation->updateTaskCount(1u, nonDefaultOsContextId);
EXPECT_TRUE(allocation->isUsedByOsContext(defaultOsContextId));
EXPECT_TRUE(allocation->isUsedByOsContext(nonDefaultOsContextId));
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
EXPECT_FALSE(device->getUltCommandStreamReceiver<FamilyType>().flushBatchedSubmissionsCalled);
EXPECT_FALSE(nonDefaultCommandStreamReceiver.flushBatchedSubmissionsCalled);
asyncDeleter->deferDeletion(new DeferrableAllocationDeletion(*memoryManager, *allocation));
while (allocation->isUsedByOsContext(nonDefaultOsContextId) && !device->getUltCommandStreamReceiver<FamilyType>().flushBatchedSubmissionsCalled) // wait for second context completion signal
std::this_thread::yield();
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
EXPECT_FALSE(nonDefaultCommandStreamReceiver.flushBatchedSubmissionsCalled);
asyncDeleter->allowExit = true;
*hwTag = 1u;
}
HWTEST_F(DeferrableAllocationDeletionTest, givenDeferrableAllocationDeletionWhenFlushedTaskIsGreaterThanAllocationTaskCountThenDoNotProgrammTagUpdate) {
auto &nonDefaultCommandStreamReceiver = static_cast<UltCommandStreamReceiver<FamilyType> &>(*device->commandStreamReceivers[1]);
auto nonDefaultOsContextId = nonDefaultCommandStreamReceiver.getOsContext().getContextId();
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
*hwTag = 0u;
*nonDefaultCommandStreamReceiver.getTagAddress() = 1u;
nonDefaultCommandStreamReceiver.setLatestFlushedTaskCount(4u);
allocation->updateTaskCount(1u, nonDefaultOsContextId);
allocation->updateTaskCount(1u, defaultOsContextId);
auto used = nonDefaultCommandStreamReceiver.getCS(0u).getUsed();
asyncDeleter->deferDeletion(new DeferrableAllocationDeletion(*memoryManager, *allocation));
while (allocation->isUsedByOsContext(nonDefaultOsContextId) && !device->getUltCommandStreamReceiver<FamilyType>().flushBatchedSubmissionsCalled) // wait for second context completion signal
std::this_thread::yield();
EXPECT_FALSE(nonDefaultCommandStreamReceiver.flushBatchedSubmissionsCalled);
EXPECT_EQ(used, nonDefaultCommandStreamReceiver.getCS(0u).getUsed());
asyncDeleter->allowExit = true;
*hwTag = 1u;
}
TEST_F(DeferrableAllocationDeletionTest, givenNotUsedAllocationWhenApplyDeletionThenDontWait) {
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
EXPECT_FALSE(allocation->isUsed());
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
while (!asyncDeleter->doWorkInBackground)
std::this_thread::yield(); //wait for start async thread work
std::unique_lock<std::mutex> lock(asyncDeleter->queueMutex);
asyncDeleter->allowExit = true;
lock.unlock();
asyncDeleter->deferDeletion(new DeferrableAllocationDeletion(*memoryManager, *allocation));
while (!asyncDeleter->shouldStopReached) // wait async thread job end
std::this_thread::yield();
EXPECT_EQ(1u, memoryManager->freeGraphicsMemoryCalled);
}
TEST_F(DeferrableAllocationDeletionTest, givenTwoAllocationsUsedByOneOsContextsEnqueuedToAsyncDeleterWhenOneAllocationIsCompletedThenReleaseThatAllocation) {
auto allocation1 = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
auto allocation2 = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
*hwTag = 1u;
allocation1->updateTaskCount(2u, defaultOsContextId);
allocation2->updateTaskCount(1u, defaultOsContextId);
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
EXPECT_TRUE(allocation1->isUsed());
EXPECT_TRUE(allocation2->isUsed());
asyncDeleter->deferDeletion(new DeferrableAllocationDeletion(*memoryManager, *allocation1));
asyncDeleter->deferDeletion(new DeferrableAllocationDeletion(*memoryManager, *allocation2));
while (0u == memoryManager->freeGraphicsMemoryCalled) // wait for delete second allocation
std::this_thread::yield();
EXPECT_EQ(1u, memoryManager->freeGraphicsMemoryCalled);
asyncDeleter->allowExit = true;
*hwTag = 2u;
}
TEST_F(DeferrableAllocationDeletionTest, givenNotCompletedAllocationWhenDeletionIsAppliedThenReturnFalse) {
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
*hwTag = 0u;
allocation->updateTaskCount(1u, defaultOsContextId);
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
DeferrableAllocationDeletion deletion{*memoryManager, *allocation};
EXPECT_FALSE(deletion.apply());
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
*hwTag = 1u; // complete allocation
EXPECT_TRUE(deletion.apply());
EXPECT_EQ(1u, memoryManager->freeGraphicsMemoryCalled);
}
TEST_F(DeferrableAllocationDeletionTest, givenNotUsedAllocationWhenDeletionIsAppliedThenReturnTrue) {
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
EXPECT_FALSE(allocation->isUsed());
DeferrableAllocationDeletion deletion{*memoryManager, *allocation};
EXPECT_TRUE(deletion.apply());
EXPECT_EQ(1u, memoryManager->freeGraphicsMemoryCalled);
}
TEST_F(DeferrableAllocationDeletionTest, givenAllocationUsedByUnregisteredEngineWhenDeletionIsAppliedThenReturnTrue) {
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
allocation->updateTaskCount(2u, defaultOsContextId);
EXPECT_TRUE(allocation->isUsed());
DeferrableAllocationDeletion deletion{*memoryManager, *allocation};
device.reset();
executionEnvironment->rootDeviceEnvironments.clear();
EXPECT_EQ(0u, memoryManager->registeredEngines.size());
EXPECT_TRUE(allocation->isUsed());
memoryManager->freeGraphicsMemoryCalled = 0u;
EXPECT_TRUE(deletion.apply());
EXPECT_EQ(1u, memoryManager->freeGraphicsMemoryCalled);
}
HWTEST_F(DeferrableAllocationDeletionTest, givenMultiTileWhenTaskCompletedOnSingleTileThenDoNotFreeGraphicsAllocation) {
auto csr = reinterpret_cast<UltCommandStreamReceiver<FamilyType> *>(device->getDefaultEngine().commandStreamReceiver);
csr->setActivePartitions(2u);
csr->postSyncWriteOffset = 32;
auto hwTagNextTile = ptrOffset(hwTag, 32);
auto allocation = memoryManager->allocateGraphicsMemoryWithProperties(MockAllocationProperties{device->getRootDeviceIndex(), MemoryConstants::pageSize});
allocation->updateTaskCount(1u, defaultOsContextId);
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
DeferrableAllocationDeletion deletion{*memoryManager, *allocation};
*hwTag = 0u;
*hwTagNextTile = 0u;
EXPECT_FALSE(deletion.apply());
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
*hwTag = 1u;
EXPECT_FALSE(deletion.apply());
EXPECT_EQ(0u, memoryManager->freeGraphicsMemoryCalled);
*hwTagNextTile = 1u;
EXPECT_TRUE(deletion.apply());
EXPECT_EQ(1u, memoryManager->freeGraphicsMemoryCalled);
}
|
