compute-runtime/opencl/test/unit_test/command_queue/oom_buffer_tests.cpp

277 lines
10 KiB
C++

/*
* Copyright (C) 2018-2024 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#include "shared/source/memory_manager/memory_manager.h"
#include "shared/test/common/fixtures/memory_management_fixture.h"
#include "shared/test/common/test_macros/test.h"
#include "opencl/source/command_queue/command_queue_hw.h"
#include "opencl/source/event/event.h"
#include "opencl/test/unit_test/command_queue/command_queue_fixture.h"
#include "opencl/test/unit_test/command_queue/enqueue_fixture.h"
#include "opencl/test/unit_test/fixtures/buffer_fixture.h"
#include "opencl/test/unit_test/fixtures/cl_device_fixture.h"
#include "opencl/test/unit_test/fixtures/hello_world_kernel_fixture.h"
#include "opencl/test/unit_test/fixtures/simple_arg_kernel_fixture.h"
#include "opencl/test/unit_test/mocks/mock_cl_device.h"
using namespace NEO;
struct OOMSetting {
bool oomCS;
bool oomISH;
};
static OOMSetting oomSettings[] = {
{true, false},
{false, true},
{true, true}};
struct OOMCommandQueueBufferTest : public MemoryManagementFixture,
public ClDeviceFixture,
public CommandQueueFixture,
public SimpleArgKernelFixture,
public HelloWorldKernelFixture,
public ::testing::TestWithParam<OOMSetting> {
using CommandQueueFixture::setUp;
using HelloWorldKernelFixture::setUp;
using SimpleArgKernelFixture::setUp;
void SetUp() override {
MemoryManagement::breakOnAllocationEvent = 77;
MemoryManagementFixture::setUp();
ClDeviceFixture::setUp();
context = new MockContext(pClDevice);
BufferDefaults::context = context;
CommandQueueFixture::setUp(context, pClDevice, 0);
SimpleArgKernelFixture::setUp(pClDevice);
HelloWorldKernelFixture::setUp(pClDevice, "CopyBuffer_simd", "CopyBuffer");
srcBuffer = BufferHelper<>::create();
dstBuffer = BufferHelper<>::create();
const auto &oomSetting = GetParam();
auto oomSize = 10u;
if (oomSetting.oomCS) {
auto &cs = pCmdQ->getCS(oomSize);
// CommandStream may be larger than requested so grab what wasnt requested
cs.getSpace(cs.getAvailableSpace() - oomSize);
ASSERT_EQ(oomSize, cs.getAvailableSpace());
}
if (oomSetting.oomISH) {
auto &ish = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, oomSize);
// IndirectHeap may be larger than requested so grab what wasnt requested
ish.getSpace(ish.getAvailableSpace() - oomSize);
ASSERT_EQ(oomSize, ish.getAvailableSpace());
}
}
void TearDown() override {
delete dstBuffer;
delete srcBuffer;
context->release();
HelloWorldKernelFixture::tearDown();
SimpleArgKernelFixture::tearDown();
CommandQueueFixture::tearDown();
ClDeviceFixture::tearDown();
MemoryManagementFixture::tearDown();
}
MockContext *context = nullptr;
Buffer *srcBuffer = nullptr;
Buffer *dstBuffer = nullptr;
};
HWTEST_P(OOMCommandQueueBufferTest, WhenCopyingBufferThenMaxAvailableSpaceIsNotExceeded) {
CommandQueueHw<FamilyType> cmdQ(context, pClDevice, 0, false);
auto &commandStream = pCmdQ->getCS(1024);
auto &indirectHeap = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, 10);
auto usedBeforeCS = commandStream.getUsed();
auto usedBeforeISH = indirectHeap.getUsed();
auto retVal1 = EnqueueCopyBufferHelper<>::enqueue(pCmdQ);
EXPECT_EQ(CL_SUCCESS, retVal1);
auto retVal2 = EnqueueCopyBufferHelper<>::enqueue(&cmdQ);
EXPECT_EQ(CL_SUCCESS, retVal2);
auto usedAfterCS = commandStream.getUsed();
auto usedAfterISH = indirectHeap.getUsed();
EXPECT_LE(usedAfterCS - usedBeforeCS, commandStream.getMaxAvailableSpace());
if (usedAfterISH > usedBeforeISH) {
EXPECT_LE(usedAfterISH - usedBeforeISH, indirectHeap.getMaxAvailableSpace());
} else {
EXPECT_LE(usedAfterISH, indirectHeap.getMaxAvailableSpace());
}
}
HWTEST_P(OOMCommandQueueBufferTest, WhenFillingBufferThenMaxAvailableSpaceIsNotExceeded) {
CommandQueueHw<FamilyType> cmdQ(context, pClDevice, 0, false);
auto &commandStream = pCmdQ->getCS(1024);
auto &indirectHeap = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, 10);
auto usedBeforeCS = commandStream.getUsed();
auto usedBeforeISH = indirectHeap.getUsed();
auto retVal1 = EnqueueFillBufferHelper<>::enqueue(pCmdQ);
EXPECT_EQ(CL_SUCCESS, retVal1);
auto retVal2 = EnqueueFillBufferHelper<>::enqueue(&cmdQ);
EXPECT_EQ(CL_SUCCESS, retVal2);
auto usedAfterCS = commandStream.getUsed();
auto usedAfterISH = indirectHeap.getUsed();
EXPECT_LE(usedAfterCS - usedBeforeCS, commandStream.getMaxAvailableSpace());
if (usedAfterISH > usedBeforeISH) {
EXPECT_LE(usedAfterISH - usedBeforeISH, indirectHeap.getMaxAvailableSpace());
} else {
EXPECT_LE(usedAfterISH, indirectHeap.getMaxAvailableSpace());
}
}
HWTEST_P(OOMCommandQueueBufferTest, WhenReadingBufferThenMaxAvailableSpaceIsNotExceeded) {
CommandQueueHw<FamilyType> cmdQ(context, pClDevice, 0, false);
auto &commandStream = pCmdQ->getCS(1024);
auto &indirectHeap = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, 10);
auto usedBeforeCS = commandStream.getUsed();
auto usedBeforeISH = indirectHeap.getUsed();
auto retVal1 = EnqueueReadBufferHelper<>::enqueue(pCmdQ);
EXPECT_EQ(CL_SUCCESS, retVal1);
auto retVal2 = EnqueueReadBufferHelper<>::enqueue(&cmdQ);
EXPECT_EQ(CL_SUCCESS, retVal2);
auto usedAfterCS = commandStream.getUsed();
auto usedAfterISH = indirectHeap.getUsed();
EXPECT_LE(usedAfterCS - usedBeforeCS, commandStream.getMaxAvailableSpace());
if (usedAfterISH > usedBeforeISH) {
EXPECT_LE(usedAfterISH - usedBeforeISH, indirectHeap.getMaxAvailableSpace());
} else {
EXPECT_LE(usedAfterISH, indirectHeap.getMaxAvailableSpace());
}
}
HWTEST_P(OOMCommandQueueBufferTest, WhenWritingBufferThenMaxAvailableSpaceIsNotExceeded) {
CommandQueueHw<FamilyType> cmdQ(context, pClDevice, 0, false);
auto &commandStream = pCmdQ->getCS(1024);
auto &indirectHeap = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, 10);
auto usedBeforeCS = commandStream.getUsed();
auto usedBeforeISH = indirectHeap.getUsed();
auto retVal1 = EnqueueWriteBufferHelper<>::enqueue(pCmdQ);
EXPECT_EQ(CL_SUCCESS, retVal1);
auto retVal2 = EnqueueWriteBufferHelper<>::enqueue(&cmdQ);
EXPECT_EQ(CL_SUCCESS, retVal2);
auto usedAfterCS = commandStream.getUsed();
auto usedAfterISH = indirectHeap.getUsed();
EXPECT_LE(usedAfterCS - usedBeforeCS, commandStream.getMaxAvailableSpace());
if (usedAfterISH > usedBeforeISH) {
EXPECT_LE(usedAfterISH - usedBeforeISH, indirectHeap.getMaxAvailableSpace());
} else {
EXPECT_LE(usedAfterISH, indirectHeap.getMaxAvailableSpace());
}
}
HWTEST_P(OOMCommandQueueBufferTest, WhenWritingBufferRectThenMaxAvailableSpaceIsNotExceeded) {
CommandQueueHw<FamilyType> cmdQ(context, pClDevice, 0, false);
auto &commandStream = pCmdQ->getCS(1024);
auto &indirectHeap = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, 10);
auto usedBeforeCS = commandStream.getUsed();
auto usedBeforeISH = indirectHeap.getUsed();
auto retVal1 = EnqueueWriteBufferRectHelper<>::enqueue(pCmdQ);
EXPECT_EQ(CL_SUCCESS, retVal1);
auto retVal2 = EnqueueWriteBufferRectHelper<>::enqueue(&cmdQ);
EXPECT_EQ(CL_SUCCESS, retVal2);
auto usedAfterCS = commandStream.getUsed();
auto usedAfterISH = indirectHeap.getUsed();
EXPECT_LE(usedAfterCS - usedBeforeCS, commandStream.getMaxAvailableSpace());
if (usedAfterISH > usedBeforeISH) {
EXPECT_LE(usedAfterISH - usedBeforeISH, indirectHeap.getMaxAvailableSpace());
} else {
EXPECT_LE(usedAfterISH, indirectHeap.getMaxAvailableSpace());
}
}
HWTEST_P(OOMCommandQueueBufferTest, GivenHelloWorldWhenEnqueingKernelThenMaxAvailableSpaceIsNotExceeded) {
typedef HelloWorldKernelFixture KernelFixture;
CommandQueueHw<FamilyType> cmdQ(context, pClDevice, 0, false);
auto &commandStream = pCmdQ->getCS(1024);
auto &indirectHeap = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, 10);
auto usedBeforeCS = commandStream.getUsed();
auto usedBeforeISH = indirectHeap.getUsed();
auto retVal1 = EnqueueKernelHelper<>::enqueueKernel(
pCmdQ,
KernelFixture::pKernel);
auto retVal2 = EnqueueKernelHelper<>::enqueueKernel(
&cmdQ,
KernelFixture::pKernel);
auto usedAfterCS = commandStream.getUsed();
auto usedAfterISH = indirectHeap.getUsed();
EXPECT_LE(usedAfterCS - usedBeforeCS, commandStream.getMaxAvailableSpace());
if (usedAfterISH > usedBeforeISH) {
EXPECT_LE(usedAfterISH - usedBeforeISH, indirectHeap.getMaxAvailableSpace());
} else {
EXPECT_LE(usedAfterISH, indirectHeap.getMaxAvailableSpace());
}
EXPECT_EQ(CL_SUCCESS, retVal1);
EXPECT_EQ(CL_SUCCESS, retVal2);
}
HWTEST_P(OOMCommandQueueBufferTest, GivenSimpleArgWhenEnqueingKernelThenMaxAvailableSpaceIsNotExceeded) {
typedef SimpleArgKernelFixture KernelFixture;
CommandQueueHw<FamilyType> cmdQ(context, pClDevice, 0, false);
auto &commandStream = pCmdQ->getCS(1024);
auto &indirectHeap = pCmdQ->getIndirectHeap(IndirectHeap::Type::dynamicState, 10);
auto usedBeforeCS = commandStream.getUsed();
auto usedBeforeISH = indirectHeap.getUsed();
auto retVal1 = EnqueueKernelHelper<>::enqueueKernel(
pCmdQ,
KernelFixture::pKernel);
auto retVal2 = EnqueueKernelHelper<>::enqueueKernel(
&cmdQ,
KernelFixture::pKernel);
auto usedAfterCS = commandStream.getUsed();
auto usedAfterISH = indirectHeap.getUsed();
EXPECT_LE(usedAfterCS - usedBeforeCS, commandStream.getMaxAvailableSpace());
if (usedAfterISH > usedBeforeISH) {
EXPECT_LE(usedAfterISH - usedBeforeISH, indirectHeap.getMaxAvailableSpace());
} else {
EXPECT_LE(usedAfterISH, indirectHeap.getMaxAvailableSpace());
}
EXPECT_EQ(CL_SUCCESS, retVal1);
EXPECT_EQ(CL_SUCCESS, retVal2);
}
INSTANTIATE_TEST_SUITE_P(
OOM,
OOMCommandQueueBufferTest,
testing::ValuesIn(oomSettings));