Add gem mmap offset query with retry

Related-To: NEO-6276

Signed-off-by: Milczarek, Slawomir <[email protected]>

Author: smilczar

opencl/test/unit_test/os_interface/linux/device_command_stream_fixture_dg1.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -45,6 +45,8 @@ class DrmMockCustomDg1 : public DrmMockCustom {
     __u64 mmapOffsetOffset = 0;
     __u64 mmapOffsetFlags = 0;
 
+    bool failOnMmapOffset = false;
+
     int ioctlExtra(unsigned long request, void *arg) override {
         switch (request) {
         case DRM_IOCTL_I915_GEM_CREATE_EXT: {
@@ -61,6 +63,9 @@ class DrmMockCustomDg1 : public DrmMockCustom {
             mmapOffsetOffset = mmapOffsetParams->offset;
             mmapOffsetFlags = mmapOffsetParams->flags;
             ioctlDg1_cnt.gemMmapOffset++;
+            if (failOnMmapOffset == true) {
+                return -1;
+            }
         } break;
         default: {
             std::cout << std::hex << DRM_IOCTL_I915_GEM_WAIT << std::endl;

opencl/test/unit_test/os_interface/linux/drm_memory_manager_local_memory_tests_dg1.cpp

@@ -170,6 +170,48 @@ class DrmMemoryManagerLocalMemoryWithCustomMockTest : public ::testing::Test {
     std::unique_ptr<TestedDrmMemoryManager> memoryManager;
 };
 
+extern bool retrieveMmapOffsetForBufferObject(Drm &drm, BufferObject &bo, uint64_t flags, uint64_t &offset);
+
+TEST_F(DrmMemoryManagerLocalMemoryTest, givenDrmWhenRetrieveMmapOffsetForBufferObjectSucceedsThenReturnTrueAndCorrectOffset) {
+    BufferObject bo(mock, 1, 1024, 0);
+    mock->offset = 21;
+
+    uint64_t offset = 0;
+    auto ret = retrieveMmapOffsetForBufferObject(*mock, bo, 0, offset);
+
+    EXPECT_TRUE(ret);
+    EXPECT_EQ(21u, offset);
+}
+
+TEST_F(DrmMemoryManagerLocalMemoryTest, givenDrmWhenRetrieveMmapOffsetForBufferObjectFailsThenReturnFalse) {
+    BufferObject bo(mock, 1, 1024, 0);
+    mock->mmapOffsetRetVal = -1;
+
+    uint64_t offset = 0;
+    auto ret = retrieveMmapOffsetForBufferObject(*mock, bo, 0, offset);
+
+    EXPECT_FALSE(ret);
+}
+
+TEST_F(DrmMemoryManagerLocalMemoryTest, givenDrmWhenRetrieveMmapOffsetForBufferObjectIsCalledThenApplyCorrectFlags) {
+    BufferObject bo(mock, 1, 1024, 0);
+
+    uint64_t offset = 0;
+    auto ret = retrieveMmapOffsetForBufferObject(*mock, bo, 0, offset);
+
+    EXPECT_TRUE(ret);
+    EXPECT_EQ(4u, mock->mmapOffsetFlagsReceived);
+
+    mock->mmapOffsetRetVal = -1;
+
+    for (uint64_t flags : {I915_MMAP_OFFSET_WC, I915_MMAP_OFFSET_WB}) {
+        ret = retrieveMmapOffsetForBufferObject(*mock, bo, flags, offset);
+
+        EXPECT_FALSE(ret);
+        EXPECT_EQ(flags, mock->mmapOffsetFlagsReceived);
+    }
+}
+
 TEST_F(DrmMemoryManagerLocalMemoryTest, givenDrmMemoryManagerWhenCreateBufferObjectInMemoryRegionIsCalledThenBufferObjectWithAGivenGpuAddressAndSizeIsCreatedAndAllocatedInASpecifiedMemoryRegion) {
     DebugManagerStateRestore restorer;
     DebugManager.flags.EnableLocalMemory.set(1);
@@ -1433,16 +1475,16 @@ TEST_F(DrmMemoryManagerTestDg1, givenDrmMemoryManagerWhenLockUnlockIsCalledOnAll
     EXPECT_EQ(static_cast<uint32_t>(drmAllocation->getBO()->peekHandle()), mockDg1->mmapOffsetHandle);
     EXPECT_EQ(0u, mockDg1->mmapOffsetPad);
     EXPECT_EQ(0u, mockDg1->mmapOffsetOffset);
-    EXPECT_EQ((uint64_t)I915_MMAP_OFFSET_WC, mockDg1->mmapOffsetFlags);
+    EXPECT_EQ(4u, mockDg1->mmapOffsetFlags);
 
     memoryManager->unlockResource(allocation);
     EXPECT_EQ(nullptr, drmAllocation->getBO()->peekLockedAddress());
 
     memoryManager->freeGraphicsMemory(allocation);
 }
 
-TEST_F(DrmMemoryManagerTestDg1, givenDrmMemoryManagerWhenLockUnlockIsCalledOnAllocationInLocalMemoryButFailsOnIoctlMmapOffsetThenReturnNullPtr) {
-    mockDg1->ioctlDg1_expected.gemMmapOffset = 1;
+TEST_F(DrmMemoryManagerTestDg1, givenDrmMemoryManagerWhenLockUnlockIsCalledOnAllocationInLocalMemoryButFailsOnMmapThenReturnNullPtr) {
+    mockDg1->ioctlDg1_expected.gemMmapOffset = 2;
     this->ioctlResExt = {mockDg1->ioctl_cnt.total, -1};
     mockDg1->ioctl_res_ext = &ioctlResExt;
 
@@ -1457,6 +1499,22 @@ TEST_F(DrmMemoryManagerTestDg1, givenDrmMemoryManagerWhenLockUnlockIsCalledOnAll
     mockDg1->ioctl_res_ext = &mockDg1->NONE;
 }
 
+TEST_F(DrmMemoryManagerTestDg1, givenDrmMemoryManagerWhenLockUnlockIsCalledOnAllocationInLocalMemoryButFailsOnIoctlMmapFunctionOffsetThenReturnNullPtr) {
+    mockDg1->ioctlDg1_expected.gemMmapOffset = 2;
+    mockDg1->returnIoctlExtraErrorValue = true;
+    mockDg1->failOnMmapOffset = true;
+
+    BufferObject bo(mockDg1, 1, 0, 0);
+    DrmAllocation drmAllocation(0, GraphicsAllocation::AllocationType::UNKNOWN, &bo, nullptr, 0u, 0u, MemoryPool::LocalMemory);
+    EXPECT_NE(nullptr, drmAllocation.getBO());
+
+    auto ptr = memoryManager->lockResource(&drmAllocation);
+    EXPECT_EQ(nullptr, ptr);
+
+    memoryManager->unlockResource(&drmAllocation);
+    mockDg1->ioctl_res_ext = &mockDg1->NONE;
+}
+
 TEST_F(DrmMemoryManagerTestDg1, givenDrmMemoryManagerWhenLockUnlockIsCalledOnAllocationInLocalMemoryButBufferObjectIsNullThenReturnNullPtr) {
     DrmAllocation drmAllocation(0, GraphicsAllocation::AllocationType::UNKNOWN, nullptr, nullptr, 0u, 0u, MemoryPool::LocalMemory);
 

opencl/test/unit_test/os_interface/linux/drm_mock_dg1.h

@@ -31,6 +31,7 @@ class DrmMockDg1 : public DrmMock {
     int gemCreateExtRetVal = 0;
 
     //DRM_IOCTL_I915_GEM_MMAP_OFFSET
+    __u64 mmapOffsetFlagsReceived = 0;
     __u64 offset = 0;
     int mmapOffsetRetVal = 0;
 
@@ -79,6 +80,7 @@ class DrmMockDg1 : public DrmMock {
 
         } else if (request == DRM_IOCTL_I915_GEM_MMAP_OFFSET) {
             auto mmap_arg = static_cast<drm_i915_gem_mmap_offset *>(arg);
+            mmapOffsetFlagsReceived = mmap_arg->flags;
             mmap_arg->offset = offset;
             return mmapOffsetRetVal;
         }

shared/source/os_interface/linux/drm_memory_manager_local_memory_dg1.cpp

@@ -19,16 +19,22 @@
 namespace NEO {
 
 bool retrieveMmapOffsetForBufferObject(Drm &drm, BufferObject &bo, uint64_t flags, uint64_t &offset) {
+    constexpr uint64_t mmapOffsetFixed = 4;
+
     drm_i915_gem_mmap_offset mmapOffset = {};
     mmapOffset.handle = bo.peekHandle();
-    mmapOffset.flags = flags;
+    mmapOffset.flags = mmapOffsetFixed;
 
     auto ret = drm.ioctl(DRM_IOCTL_I915_GEM_MMAP_OFFSET, &mmapOffset);
     if (ret != 0) {
-        int err = drm.getErrno();
-        PRINT_DEBUG_STRING(DebugManager.flags.PrintDebugMessages.get(), stderr, "ioctl(DRM_IOCTL_I915_GEM_MMAP_OFFSET) failed with %d. errno=%d(%s)\n", ret, err, strerror(err));
-        DEBUG_BREAK_IF(ret != 0);
-        return false;
+        mmapOffset.flags = flags;
+        ret = drm.ioctl(DRM_IOCTL_I915_GEM_MMAP_OFFSET, &mmapOffset);
+        if (ret != 0) {
+            int err = drm.getErrno();
+            PRINT_DEBUG_STRING(DebugManager.flags.PrintDebugMessages.get(), stderr, "ioctl(DRM_IOCTL_I915_GEM_MMAP_OFFSET) failed with %d. errno=%d(%s)\n", ret, err, strerror(err));
+            DEBUG_BREAK_IF(ret != 0);
+            return false;
+        }
     }
 
     offset = mmapOffset.offset;