Initial commit

Change-Id: I4bf1707bd3dfeadf2c17b0a7daff372b1925ebbd
2026-01-03 23:03:02 +08:00 · 2017-12-21 00:45:38 +01:00
commit 7e9ad41290
1350 changed files with 233156 additions and 0 deletions
--- a/unit_tests/mem_obj/mem_obj_destruction_tests.cpp
+++ b/unit_tests/mem_obj/mem_obj_destruction_tests.cpp
@@ -0,0 +1,274 @@
+/*
+ * Copyright (c) 2017, Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include "runtime/mem_obj/mem_obj.h"
+#include "unit_tests/mocks/mock_context.h"
+#include "unit_tests/mocks/mock_device.h"
+#include "unit_tests/mocks/mock_memory_manager.h"
+#include "unit_tests/libult/ult_command_stream_receiver.h"
+#include "test.h"
+
+using namespace OCLRT;
+
+template <typename Family>
+class MyCsr : public UltCommandStreamReceiver<Family> {
+  public:
+    MyCsr(const HardwareInfo &hwInfo) : UltCommandStreamReceiver<Family>(hwInfo) {}
+    MOCK_METHOD1(waitForFlushStamp, bool(FlushStamp &flushStampToWait));
+    MOCK_METHOD3(waitForCompletionWithTimeout, bool(bool enableTimeout, int64_t timeoutMs, uint32_t taskCountToWait));
+};
+
+void CL_CALLBACK emptyDestructorCallback(cl_mem memObj, void *userData) {
+}
+
+TEST(MemObjDebugFlags, givenDefaultDebugFlagsWhenMemObjDestructorIsCalledThenMemObjDestroysAllocationsSynchronously) {
+    EXPECT_TRUE(DebugManager.flags.EnableAsyncDestroyAllocations.get());
+}
+
+class MemObjDestructionTest : public ::testing::TestWithParam<bool> {
+  public:
+    void SetUp() override {
+        memoryManager = new MockMemoryManager;
+        device = static_cast<MockDevice *>(context.getDevice(0));
+        device->injectMemoryManager(memoryManager);
+        context.setMemoryManager(memoryManager);
+        allocation = memoryManager->allocateGraphicsMemory(size, MemoryConstants::pageSize);
+        memObj = new MemObj(&context, CL_MEM_OBJECT_BUFFER,
+                            CL_MEM_READ_WRITE,
+                            size,
+                            nullptr, nullptr, allocation, true, false, false);
+        *context.getDevice(0)->getTagAddress() = 0;
+    }
+
+    void makeMemObjUsed() {
+        memObj->getGraphicsAllocation()->taskCount = 3;
+    }
+
+    void makeMemObjNotReady() {
+        makeMemObjUsed();
+        *context.getDevice(0)->getTagAddress() = memObj->getGraphicsAllocation()->taskCount - 1;
+    }
+
+    void makeMemObjReady() {
+        makeMemObjUsed();
+        *context.getDevice(0)->getTagAddress() = memObj->getGraphicsAllocation()->taskCount;
+    }
+
+    MockDevice *device;
+    MockMemoryManager *memoryManager;
+    MockContext context;
+    GraphicsAllocation *allocation;
+    MemObj *memObj;
+    size_t size = MemoryConstants::pageSize;
+};
+
+class MemObjAsyncDestructionTest : public MemObjDestructionTest {
+  public:
+    void SetUp() override {
+        DebugManager.flags.EnableAsyncDestroyAllocations.set(true);
+        MemObjDestructionTest::SetUp();
+    }
+    void TearDown() override {
+        MemObjDestructionTest::TearDown();
+        DebugManager.flags.EnableAsyncDestroyAllocations.set(defaultFlag);
+    }
+    bool defaultFlag = DebugManager.flags.EnableAsyncDestroyAllocations.get();
+};
+
+class MemObjSyncDestructionTest : public MemObjDestructionTest {
+  public:
+    void SetUp() override {
+        DebugManager.flags.EnableAsyncDestroyAllocations.set(false);
+        MemObjDestructionTest::SetUp();
+    }
+    void TearDown() override {
+        MemObjDestructionTest::TearDown();
+        DebugManager.flags.EnableAsyncDestroyAllocations.set(defaultFlag);
+    }
+    bool defaultFlag = DebugManager.flags.EnableAsyncDestroyAllocations.get();
+};
+
+TEST_P(MemObjAsyncDestructionTest, givenMemObjWithDestructableAllocationWhenAsyncDestructionsAreEnabledAndAllocationIsNotReadyAndMemObjectIsDestructedThenAllocationIsDeferred) {
+    bool isMemObjReady;
+    bool expectedDeferration;
+    isMemObjReady = GetParam();
+    expectedDeferration = !isMemObjReady;
+
+    if (isMemObjReady) {
+        makeMemObjReady();
+    } else {
+        makeMemObjNotReady();
+    }
+    EXPECT_TRUE(memoryManager->isAllocationListEmpty());
+
+    delete memObj;
+
+    EXPECT_EQ(!expectedDeferration, memoryManager->isAllocationListEmpty());
+    if (expectedDeferration) {
+        EXPECT_EQ(allocation, memoryManager->peekAllocationListHead());
+    }
+}
+
+HWTEST_P(MemObjAsyncDestructionTest, givenUsedMemObjWithAsyncDestructionsEnabledThatHasDestructorCallbacksWhenItIsDestroyedThenDestructorWaitsOnTaskCount) {
+    makeMemObjUsed();
+
+    bool hasCallbacks = GetParam();
+
+    if (hasCallbacks) {
+        memObj->setDestructorCallback(emptyDestructorCallback, nullptr);
+    }
+
+    auto mockCsr = new ::testing::NiceMock<MyCsr<FamilyType>>(device->getHardwareInfo());
+    device->resetCommandStreamReceiver(mockCsr);
+
+    bool desired = true;
+
+    auto waitForCompletionWithTimeoutMock = [=](bool enableTimeout, int64_t timeoutMs, uint32_t taskCountToWait) -> bool { return desired; };
+
+    ON_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).WillByDefault(::testing::Invoke(waitForCompletionWithTimeoutMock));
+
+    if (hasCallbacks) {
+        EXPECT_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, TimeoutControls::maxTimeout, allocation->taskCount)).Times(1);
+    } else {
+        EXPECT_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).Times(0);
+    }
+    delete memObj;
+}
+
+HWTEST_P(MemObjAsyncDestructionTest, givenUsedMemObjWithAsyncDestructionsEnabledThatHasAllocatedMappedPtrWhenItIsDestroyedThenDestructorWaitsOnTaskCount) {
+    makeMemObjUsed();
+
+    bool hasAllocatedMappedPtr = GetParam();
+
+    if (hasAllocatedMappedPtr) {
+        auto allocatedPtr = alignedMalloc(size, MemoryConstants::pageSize);
+        memObj->setAllocatedMappedPtr(allocatedPtr);
+    }
+
+    auto mockCsr = new ::testing::NiceMock<MyCsr<FamilyType>>(device->getHardwareInfo());
+    device->resetCommandStreamReceiver(mockCsr);
+
+    bool desired = true;
+
+    auto waitForCompletionWithTimeoutMock = [=](bool enableTimeout, int64_t timeoutMs, uint32_t taskCountToWait) -> bool { return desired; };
+
+    ON_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).WillByDefault(::testing::Invoke(waitForCompletionWithTimeoutMock));
+
+    if (hasAllocatedMappedPtr) {
+        EXPECT_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, TimeoutControls::maxTimeout, allocation->taskCount)).Times(1);
+    } else {
+        EXPECT_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).Times(0);
+    }
+    delete memObj;
+}
+
+HWTEST_P(MemObjAsyncDestructionTest, givenUsedMemObjWithAsyncDestructionsEnabledThatHasDestructableMappedPtrWhenItIsDestroyedThenDestructorWaitsOnTaskCount) {
+    auto storage = alignedMalloc(size, MemoryConstants::pageSize);
+
+    bool hasAllocatedMappedPtr = GetParam();
+
+    if (!hasAllocatedMappedPtr) {
+        delete memObj;
+        allocation = memoryManager->allocateGraphicsMemory(size, MemoryConstants::pageSize);
+        memObj = new MemObj(&context, CL_MEM_OBJECT_BUFFER,
+                            CL_MEM_READ_WRITE,
+                            size,
+                            storage, nullptr, allocation, true, false, false);
+    }
+    memObj->setMappedPtr(storage);
+
+    makeMemObjUsed();
+    auto mockCsr = new ::testing::NiceMock<MyCsr<FamilyType>>(device->getHardwareInfo());
+    device->resetCommandStreamReceiver(mockCsr);
+
+    bool desired = true;
+
+    auto waitForCompletionWithTimeoutMock = [=](bool enableTimeout, int64_t timeoutMs, uint32_t taskCountToWait) -> bool { return desired; };
+
+    ON_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).WillByDefault(::testing::Invoke(waitForCompletionWithTimeoutMock));
+
+    if (hasAllocatedMappedPtr) {
+        EXPECT_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, TimeoutControls::maxTimeout, allocation->taskCount)).Times(1);
+    } else {
+        EXPECT_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).Times(0);
+    }
+    delete memObj;
+
+    if (!hasAllocatedMappedPtr) {
+        alignedFree(storage);
+    }
+}
+
+HWTEST_P(MemObjSyncDestructionTest, givenMemObjWithDestructableAllocationWhenAsyncDestructionsAreDisabledThenDestructorWaitsOnTaskCount) {
+    bool isMemObjReady;
+    isMemObjReady = GetParam();
+
+    if (isMemObjReady) {
+        makeMemObjReady();
+    } else {
+        makeMemObjNotReady();
+    }
+    auto mockCsr = new ::testing::NiceMock<MyCsr<FamilyType>>(device->getHardwareInfo());
+    device->resetCommandStreamReceiver(mockCsr);
+
+    bool desired = true;
+
+    auto waitForCompletionWithTimeoutMock = [=](bool enableTimeout, int64_t timeoutMs, uint32_t taskCountToWait) -> bool { return desired; };
+
+    ON_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).WillByDefault(::testing::Invoke(waitForCompletionWithTimeoutMock));
+
+    EXPECT_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, TimeoutControls::maxTimeout, allocation->taskCount)).Times(1);
+
+    delete memObj;
+}
+
+HWTEST_P(MemObjSyncDestructionTest, givenMemObjWithDestructableAllocationWhenAsyncDestructionsAreDisabledThenAllocationIsNotDeferred) {
+    bool isMemObjReady;
+    isMemObjReady = GetParam();
+
+    if (isMemObjReady) {
+        makeMemObjReady();
+    } else {
+        makeMemObjNotReady();
+    }
+    auto mockCsr = new ::testing::NiceMock<MyCsr<FamilyType>>(device->getHardwareInfo());
+    device->resetCommandStreamReceiver(mockCsr);
+
+    bool desired = true;
+
+    auto waitForCompletionWithTimeoutMock = [=](bool enableTimeout, int64_t timeoutMs, uint32_t taskCountToWait) -> bool { return desired; };
+
+    ON_CALL(*mockCsr, waitForCompletionWithTimeout(::testing::_, ::testing::_, ::testing::_)).WillByDefault(::testing::Invoke(waitForCompletionWithTimeoutMock));
+
+    delete memObj;
+    EXPECT_TRUE(memoryManager->isAllocationListEmpty());
+}
+
+INSTANTIATE_TEST_CASE_P(
+    MemObjTests,
+    MemObjAsyncDestructionTest,
+    testing::Bool());
+
+INSTANTIATE_TEST_CASE_P(
+    MemObjTests,
+    MemObjSyncDestructionTest,
+    testing::Bool());