Add DisableZeroCopyForBuffers debug flag.

- This flag disables zero copy for all buffers.

Change-Id: I882f01942f99e399e33f5fe2750acbcc0476457c

Author: MichalMrozek

runtime/mem_obj/buffer.cpp

@@ -211,7 +211,8 @@ void Buffer::checkMemory(cl_mem_flags flags,
             if (alignUp(hostPtr, MemoryConstants::cacheLineSize) != hostPtr ||
                 alignUp(size, MemoryConstants::cacheLineSize) != size ||
                 minAddress > reinterpret_cast<uintptr_t>(hostPtr) ||
-                DebugManager.flags.DisableZeroCopyForUseHostPtr.get()) {
+                DebugManager.flags.DisableZeroCopyForUseHostPtr.get() ||
+                DebugManager.flags.DisableZeroCopyForBuffers.get()) {
                 allocateMemory = true;
                 isZeroCopy = false;
                 copyMemoryFromHostPtr = true;
@@ -224,6 +225,9 @@ void Buffer::checkMemory(cl_mem_flags flags,
     } else {
         allocateMemory = true;
         isZeroCopy = true;
+        if (DebugManager.flags.DisableZeroCopyForBuffers.get()) {
+            isZeroCopy = false;
+        }
     }
 
     if (flags & CL_MEM_COPY_HOST_PTR) {

runtime/mem_obj/mem_obj.h

@@ -27,6 +27,7 @@
 #include "runtime/helpers/mipmap.h"
 #include "runtime/sharings/sharing.h"
 #include "runtime/mem_obj/map_operations_handler.h"
+#include "runtime/os_interface/debug_settings_manager.h"
 #include <atomic>
 #include <cstdint>
 #include <vector>
@@ -119,7 +120,7 @@ class MemObj : public BaseObject<_cl_mem> {
     void waitForCsrCompletion();
     void destroyGraphicsAllocation(GraphicsAllocation *allocation, bool asyncDestroy);
     bool checkIfMemoryTransferIsRequired(size_t offsetInMemObjest, size_t offsetInHostPtr, const void *ptr, cl_command_type cmdType);
-    bool mappingOnCpuAllowed() const { return !allowTiling() && !peekSharingHandler() && !isMipMapped(this); }
+    bool mappingOnCpuAllowed() const { return !allowTiling() && !peekSharingHandler() && !isMipMapped(this) && !DebugManager.flags.DisableZeroCopyForBuffers.get(); }
     virtual size_t calculateOffsetForMapping(const MemObjOffsetArray &offset) const { return offset[0]; }
     size_t calculateMappedPtrLength(const MemObjSizeArray &size) const { return calculateOffsetForMapping(size); }
     cl_mem_object_type peekClMemObjType() const { return memObjectType; }

runtime/os_interface/DebugVariables.inl

@@ -64,6 +64,7 @@ DECLARE_DEBUG_VARIABLE(bool, DisableConcurrentBlockExecution, 0, "disables concu
 DECLARE_DEBUG_VARIABLE(bool, UseNewHeapAllocator, true, "Custom 4GB heap allocator is used")
 DECLARE_DEBUG_VARIABLE(bool, UseNoRingFlushesKmdMode, true, "Windows only, passes flag to KMD that informs KMD to not emit any ring buffer flushes.")
 DECLARE_DEBUG_VARIABLE(bool, DisableZeroCopyForUseHostPtr, false, "When active all buffer allocations created with CL_MEM_USE_HOST_PTR flag will not share memory with CPU.")
+DECLARE_DEBUG_VARIABLE(bool, DisableZeroCopyForBuffers, false, "When active all buffer allocations will not share memory with CPU.")
 /*FEATURE FLAGS*/
 DECLARE_DEBUG_VARIABLE(bool, EnableNV12, true, "Enables NV12 extension")
 DECLARE_DEBUG_VARIABLE(bool, EnablePackedYuv, true, "Enables cl_packed_yuv extension")

unit_tests/mem_obj/zero_copy_tests.cpp

@@ -147,20 +147,53 @@ TEST(ZeroCopyBufferTestWithSharedContext, GivenContextThatIsSharedAndDisableZero
     EXPECT_TRUE(buffer->isMemObjZeroCopy());
 }
 
-TEST(ZeroCopyWithDebugFlag, GivenInputsThatWouldResultInZeroCopyAndDisableZeroCopyFlagWhenBufferIsCreatedThenNonZeroCopyBufferIsReturned) {
+TEST(ZeroCopyWithDebugFlag, GivenInputsThatWouldResultInZeroCopyAndUseHostptrDisableZeroCopyFlagWhenBufferIsCreatedThenNonZeroCopyBufferIsReturned) {
     DebugManagerStateRestore stateRestore;
     DebugManager.flags.DisableZeroCopyForUseHostPtr.set(true);
     MockContext context;
-    auto host_ptr = reinterpret_cast<void *>(alignedMalloc(MemoryConstants::pageSize, MemoryConstants::pageSize));
+    auto host_ptr = alignedMalloc(MemoryConstants::pageSize, MemoryConstants::pageSize);
+    auto size = MemoryConstants::pageSize;
+    auto retVal = CL_SUCCESS;
+
+    std::unique_ptr<Buffer> buffer(Buffer::create(&context, CL_MEM_USE_HOST_PTR, size, host_ptr, retVal));
+    EXPECT_EQ(CL_SUCCESS, retVal);
+    EXPECT_FALSE(buffer->isMemObjZeroCopy());
+    alignedFree(host_ptr);
+}
+
+TEST(ZeroCopyWithDebugFlag, GivenInputsThatWouldResultInZeroCopyAndDisableZeroCopyFlagWhenBufferIsCreatedThenNonZeroCopyBufferIsReturned) {
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.DisableZeroCopyForBuffers.set(true);
+    MockContext context;
+    auto host_ptr = alignedMalloc(MemoryConstants::pageSize, MemoryConstants::pageSize);
     auto size = MemoryConstants::pageSize;
     auto retVal = CL_SUCCESS;
 
     std::unique_ptr<Buffer> buffer(Buffer::create(&context, CL_MEM_USE_HOST_PTR, size, host_ptr, retVal));
     EXPECT_EQ(CL_SUCCESS, retVal);
     EXPECT_FALSE(buffer->isMemObjZeroCopy());
+    EXPECT_FALSE(buffer->mappingOnCpuAllowed());
     alignedFree(host_ptr);
 }
 
+TEST(ZeroCopyWithDebugFlag, GivenBufferInputsThatWouldResultInZeroCopyAndDisableZeroCopyFlagWhenBufferIsCreatedThenNonZeroCopyBufferIsReturned) {
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.DisableZeroCopyForBuffers.set(true);
+    MockContext context;
+    auto retVal = CL_SUCCESS;
+    std::unique_ptr<Buffer> buffer(Buffer::create(&context, CL_MEM_ALLOC_HOST_PTR, MemoryConstants::pageSize, nullptr, retVal));
+    EXPECT_EQ(CL_SUCCESS, retVal);
+    EXPECT_FALSE(buffer->isMemObjZeroCopy());
+    EXPECT_FALSE(buffer->mappingOnCpuAllowed());
+    EXPECT_EQ(nullptr, buffer->getHostPtr());
+    EXPECT_EQ(nullptr, buffer->getAllocatedMapPtr());
+    auto bufferAllocation = buffer->getGraphicsAllocation()->getUnderlyingBuffer();
+
+    auto mapAllocation = buffer->getBasePtrForMap();
+    EXPECT_EQ(mapAllocation, buffer->getAllocatedMapPtr());
+    EXPECT_NE(mapAllocation, bufferAllocation);
+}
+
 TEST(ZeroCopyBufferWith32BitAddressing, GivenDeviceSupporting32BitAddressingWhenAskedForBufferCreationFromHostPtrThenNonZeroCopyBufferIsReturned) {
     DebugManagerStateRestore dbgRestorer;
     DebugManager.flags.Force32bitAddressing.set(true);

unit_tests/test_files/igdrcl.config

@@ -65,4 +65,5 @@ AddPatchInfoCommentsForAUBDump = false
 HwQueueSupported = false
 DisableZeroCopyForUseHostPtr = false
 SchedulerGWS = 0
+DisableZeroCopyForBuffers = false
 OverrideAubDeviceId = -1