/* * Copyright (c) 2018, 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/command_queue/command_queue_hw.h" #include "runtime/mem_obj/buffer.h" #include "unit_tests/fixtures/device_fixture.h" #include "unit_tests/mocks/mock_context.h" #include "test.h" using namespace OCLRT; struct MultipleMapBufferTest : public DeviceFixture, public ::testing::Test { template struct MockBuffer : public BufferHw { using Buffer::mapOperationsHandler; template MockBuffer(Params... params) : BufferHw(params...) { this->createFunction = BufferHw::create; }; void transferDataToHostPtr(MemObjSizeArray ©Size, MemObjOffsetArray ©Offset) override { this->copySize = copySize[0]; this->copyOffset = copyOffset[0]; transferToHostPtrCalled++; }; void transferDataFromHostPtr(MemObjSizeArray ©Size, MemObjOffsetArray ©Offset) override { this->copySize = copySize[0]; this->copyOffset = copyOffset[0]; transferFromHostPtrCalled++; }; size_t copySize = 0; size_t copyOffset = 0; uint32_t transferToHostPtrCalled = 0; uint32_t transferFromHostPtrCalled = 0; }; template struct MockCmdQ : public CommandQueueHw { MockCmdQ(Context *context, Device *device) : CommandQueueHw(context, device, 0) {} cl_int enqueueReadBuffer(Buffer *buffer, cl_bool blockingRead, size_t offset, size_t size, void *ptr, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *event) override { enqueueSize = size; enqueueOffset = offset; readBufferCalled++; if (failOnReadBuffer) { return CL_OUT_OF_RESOURCES; } return CommandQueueHw::enqueueReadBuffer(buffer, blockingRead, offset, size, ptr, numEventsInWaitList, eventWaitList, event); } cl_int enqueueWriteBuffer(Buffer *buffer, cl_bool blockingWrite, size_t offset, size_t cb, const void *ptr, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *event) override { enqueueSize = cb; enqueueOffset = offset; unmapPtr = ptr; writeBufferCalled++; if (failOnWriteBuffer) { return CL_OUT_OF_RESOURCES; } return CommandQueueHw::enqueueWriteBuffer(buffer, blockingWrite, offset, cb, ptr, numEventsInWaitList, eventWaitList, event); } cl_int enqueueMarkerWithWaitList(cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *event) override { enqueueMarkerCalled++; return CommandQueueHw::enqueueMarkerWithWaitList(numEventsInWaitList, eventWaitList, event); } uint32_t writeBufferCalled = 0; uint32_t readBufferCalled = 0; uint32_t enqueueMarkerCalled = 0; bool failOnReadBuffer = false; bool failOnWriteBuffer = false; size_t enqueueSize = 0; size_t enqueueOffset = 0; const void *unmapPtr = nullptr; }; template std::unique_ptr> createMockBuffer(bool mapOnGpu) { auto mockAlloc = pDevice->getMemoryManager()->allocateGraphicsMemory(1024); auto buffer = new MockBuffer(context, 0, 1024, mockAlloc->getUnderlyingBuffer(), mockAlloc->getUnderlyingBuffer(), mockAlloc, false, false, false); if (mapOnGpu) { buffer->setSharingHandler(new SharingHandler()); } return std::unique_ptr>(buffer); } template std::unique_ptr> createMockCmdQ() { return std::unique_ptr>(new MockCmdQ(context, pDevice)); } void SetUp() override { DeviceFixture::SetUp(); context = new MockContext(pDevice); } void TearDown() override { delete context; DeviceFixture::TearDown(); } MockContext *context = nullptr; cl_int retVal = CL_INVALID_VALUE; }; HWTEST_F(MultipleMapBufferTest, givenValidReadAndWriteBufferWhenMappedOnGpuThenAddMappedPtrAndRemoveOnUnmap) { auto buffer = createMockBuffer(true); auto cmdQ = createMockCmdQ(); EXPECT_FALSE(buffer->mappingOnCpuAllowed()); size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_WRITE, offset, size, 0, nullptr, nullptr, nullptr); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->readBufferCalled, 1u); EXPECT_EQ(cmdQ->enqueueSize, size); EXPECT_EQ(cmdQ->enqueueOffset, offset); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtr, 0, nullptr, nullptr); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->writeBufferCalled, 1u); EXPECT_EQ(cmdQ->enqueueSize, size); EXPECT_EQ(cmdQ->enqueueOffset, offset); EXPECT_EQ(cmdQ->unmapPtr, mappedPtr); } HWTEST_F(MultipleMapBufferTest, givenReadOnlyMapWhenUnmappedOnGpuThenEnqueueMarker) { auto buffer = createMockBuffer(true); auto cmdQ = createMockCmdQ(); EXPECT_FALSE(buffer->mappingOnCpuAllowed()); size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_READ, offset, size, 0, nullptr, nullptr, nullptr); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->readBufferCalled, 1u); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtr, 0, nullptr, nullptr); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->writeBufferCalled, 0u); EXPECT_EQ(cmdQ->enqueueMarkerCalled, 1u); } HWTEST_F(MultipleMapBufferTest, givenNotMappedPtrWhenUnmapedOnGpuThenReturnError) { auto buffer = createMockBuffer(true); auto cmdQ = createMockCmdQ(); EXPECT_FALSE(buffer->mappingOnCpuAllowed()); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), buffer->getBasePtrForMap(), 0, nullptr, nullptr); EXPECT_EQ(CL_INVALID_VALUE, retVal); } HWTEST_F(MultipleMapBufferTest, givenErrorFromReadBufferWhenMappedOnGpuThenDontAddMappedPtr) { auto buffer = createMockBuffer(true); auto cmdQ = createMockCmdQ(); EXPECT_FALSE(buffer->mappingOnCpuAllowed()); cmdQ->failOnReadBuffer = true; size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_READ, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_EQ(nullptr, mappedPtr); EXPECT_EQ(CL_OUT_OF_RESOURCES, retVal); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); } HWTEST_F(MultipleMapBufferTest, givenErrorFromWriteBufferWhenUnmappedOnGpuThenDontRemoveMappedPtr) { auto buffer = createMockBuffer(true); auto cmdQ = createMockCmdQ(); EXPECT_FALSE(buffer->mappingOnCpuAllowed()); cmdQ->failOnWriteBuffer = true; size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_WRITE, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtr, 0, nullptr, nullptr); EXPECT_EQ(1u, cmdQ->writeBufferCalled); EXPECT_EQ(CL_OUT_OF_RESOURCES, retVal); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); } HWTEST_F(MultipleMapBufferTest, givenUnblockedQueueWhenMappedOnCpuThenAddMappedPtrAndRemoveOnUnmap) { auto buffer = createMockBuffer(false); auto cmdQ = createMockCmdQ(); EXPECT_TRUE(buffer->mappingOnCpuAllowed()); size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_WRITE, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); EXPECT_EQ(1u, buffer->transferToHostPtrCalled); EXPECT_EQ(buffer->copySize, size); EXPECT_EQ(buffer->copyOffset, offset); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtr, 0, nullptr, nullptr); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); EXPECT_EQ(1u, buffer->transferFromHostPtrCalled); EXPECT_EQ(buffer->copySize, size); EXPECT_EQ(buffer->copyOffset, offset); } HWTEST_F(MultipleMapBufferTest, givenUnblockedQueueWhenReadOnlyMappedOnCpuThenDontMakeCpuCopy) { auto buffer = createMockBuffer(false); auto cmdQ = createMockCmdQ(); EXPECT_TRUE(buffer->mappingOnCpuAllowed()); size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_READ, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); EXPECT_EQ(1u, buffer->transferToHostPtrCalled); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtr, 0, nullptr, nullptr); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); EXPECT_EQ(0u, buffer->transferFromHostPtrCalled); } HWTEST_F(MultipleMapBufferTest, givenBlockedQueueWhenMappedOnCpuThenAddMappedPtrAndRemoveOnUnmap) { auto buffer = createMockBuffer(false); auto cmdQ = createMockCmdQ(); EXPECT_TRUE(buffer->mappingOnCpuAllowed()); UserEvent mapEvent, unmapEvent; cl_event clMapEvent = &mapEvent; cl_event clUnmapEvent = &unmapEvent; size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_WRITE, offset, size, 1, &clMapEvent, nullptr, &retVal); mapEvent.setStatus(CL_COMPLETE); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); EXPECT_EQ(buffer->copySize, size); EXPECT_EQ(buffer->copyOffset, offset); EXPECT_EQ(1u, buffer->transferToHostPtrCalled); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtr, 1, &clUnmapEvent, nullptr); unmapEvent.setStatus(CL_COMPLETE); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); EXPECT_EQ(buffer->copySize, size); EXPECT_EQ(buffer->copyOffset, offset); EXPECT_EQ(1u, buffer->transferFromHostPtrCalled); } HWTEST_F(MultipleMapBufferTest, givenBlockedQueueWhenMappedReadOnlyOnCpuThenDontMakeCpuCopy) { auto buffer = createMockBuffer(false); auto cmdQ = createMockCmdQ(); EXPECT_TRUE(buffer->mappingOnCpuAllowed()); UserEvent mapEvent, unmapEvent; cl_event clMapEvent = &mapEvent; cl_event clUnmapEvent = &unmapEvent; size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_READ, offset, size, 1, &clMapEvent, nullptr, &retVal); mapEvent.setStatus(CL_COMPLETE); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(1u, buffer->transferToHostPtrCalled); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtr, 1, &clUnmapEvent, nullptr); unmapEvent.setStatus(CL_COMPLETE); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); EXPECT_EQ(0u, buffer->transferFromHostPtrCalled); } HWTEST_F(MultipleMapBufferTest, givenInvalidPtrWhenUnmappedOnCpuThenReturnError) { auto buffer = createMockBuffer(false); auto cmdQ = createMockCmdQ(); EXPECT_TRUE(buffer->mappingOnCpuAllowed()); retVal = clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), buffer->getBasePtrForMap(), 0, nullptr, nullptr); EXPECT_EQ(CL_INVALID_VALUE, retVal); } HWTEST_F(MultipleMapBufferTest, givenMultimpleMapsWhenUnmappingThenRemoveCorrectPointers) { auto buffer = createMockBuffer(true); auto cmdQ = createMockCmdQ(); MapInfo mappedPtrs[3] = { {nullptr, 1, {{1, 0, 0}}, {{1, 0, 0}}, 0}, {nullptr, 1, {{2, 0, 0}}, {{2, 0, 0}}, 0}, {nullptr, 1, {{5, 0, 0}}, {{5, 0, 0}}, 0}, }; for (size_t i = 0; i < 3; i++) { mappedPtrs[i].ptr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_WRITE, mappedPtrs[i].offset[0], mappedPtrs[i].size[0], 0, nullptr, nullptr, &retVal); EXPECT_NE(nullptr, mappedPtrs[i].ptr); EXPECT_EQ(i + 1, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->enqueueSize, mappedPtrs[i].size[0]); EXPECT_EQ(cmdQ->enqueueOffset, mappedPtrs[i].offset[0]); } // reordered unmap clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtrs[1].ptr, 0, nullptr, nullptr); EXPECT_EQ(2u, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->unmapPtr, mappedPtrs[1].ptr); EXPECT_EQ(cmdQ->enqueueSize, mappedPtrs[1].size[0]); EXPECT_EQ(cmdQ->enqueueOffset, mappedPtrs[1].offset[0]); clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtrs[2].ptr, 0, nullptr, nullptr); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->unmapPtr, mappedPtrs[2].ptr); EXPECT_EQ(cmdQ->enqueueSize, mappedPtrs[2].size[0]); EXPECT_EQ(cmdQ->enqueueOffset, mappedPtrs[2].offset[0]); clEnqueueUnmapMemObject(cmdQ.get(), buffer.get(), mappedPtrs[0].ptr, 0, nullptr, nullptr); EXPECT_EQ(0u, buffer->mapOperationsHandler.size()); EXPECT_EQ(cmdQ->unmapPtr, mappedPtrs[0].ptr); EXPECT_EQ(cmdQ->enqueueSize, mappedPtrs[0].size[0]); EXPECT_EQ(cmdQ->enqueueOffset, mappedPtrs[0].offset[0]); } HWTEST_F(MultipleMapBufferTest, givenOverlapingPtrWhenMappingOnGpuForWriteThenReturnError) { auto buffer = createMockBuffer(true); auto cmdQ = createMockCmdQ(); EXPECT_FALSE(buffer->mappingOnCpuAllowed()); size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_READ, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(CL_SUCCESS, retVal); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); offset++; void *mappedPtr2 = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_WRITE, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_EQ(nullptr, mappedPtr2); EXPECT_EQ(CL_INVALID_OPERATION, retVal); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); } HWTEST_F(MultipleMapBufferTest, givenOverlapingPtrWhenMappingOnCpuForWriteThenReturnError) { auto buffer = createMockBuffer(false); auto cmdQ = createMockCmdQ(); EXPECT_TRUE(buffer->mappingOnCpuAllowed()); size_t offset = 1; size_t size = 3; void *mappedPtr = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_READ, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_NE(nullptr, mappedPtr); EXPECT_EQ(CL_SUCCESS, retVal); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); offset++; void *mappedPtr2 = clEnqueueMapBuffer(cmdQ.get(), buffer.get(), CL_FALSE, CL_MAP_WRITE, offset, size, 0, nullptr, nullptr, &retVal); EXPECT_EQ(nullptr, mappedPtr2); EXPECT_EQ(CL_INVALID_OPERATION, retVal); EXPECT_EQ(1u, buffer->mapOperationsHandler.size()); }