Debug flag to print blit dispatch details

Change-Id: I1eb033449a49485b459249f634589e546492d99f
Signed-off-by: Bartosz Dunajski <[email protected]>

Author: BartoszDunajski

opencl/test/unit_test/mem_obj/buffer_bcs_tests.cpp

@@ -23,6 +23,8 @@
 #include "opencl/test/unit_test/test_macros/test_checks_ocl.h"
 #include "test.h"
 
+#include <cinttypes>
+
 using namespace NEO;
 
 struct BcsBufferTests : public ::testing::Test {
@@ -239,6 +241,38 @@ HWTEST_TEMPLATED_F(BcsBufferTests, givenBcsSupportedWhenEnqueueBufferOperationIs
     EXPECT_EQ(14u, bcsCsr->blitBufferCalled);
 }
 
+HWTEST_TEMPLATED_F(BcsBufferTests, givenDebugFlagSetWhenDispatchingBlitCommandsThenPrintDispatchDetails) {
+    DebugManager.flags.PrintBlitDispatchDetails.set(true);
+
+    uint32_t maxBlitWidth = static_cast<uint32_t>(BlitterConstants::maxBlitWidth);
+    uint32_t copySize = maxBlitWidth + 5;
+
+    auto myHostPtr = std::make_unique<uint8_t[]>(copySize);
+    uint64_t hostPtrAddr = castToUint64(myHostPtr.get());
+
+    auto bufferForBlt = clUniquePtr(Buffer::create(bcsMockContext.get(), CL_MEM_READ_WRITE, copySize, nullptr, retVal));
+    bufferForBlt->forceDisallowCPUCopy = true;
+
+    uint64_t bufferGpuAddr = bufferForBlt->getGraphicsAllocation(0)->getGpuAddress();
+
+    testing::internal::CaptureStdout();
+
+    commandQueue->enqueueWriteBuffer(bufferForBlt.get(), CL_TRUE, 0, copySize, myHostPtr.get(), nullptr, 0, nullptr, nullptr);
+
+    std::string output = testing::internal::GetCapturedStdout();
+    EXPECT_NE(0u, output.size());
+
+    char expectedStr[512] = {};
+    snprintf(expectedStr, 512, "\nBlit dispatch with AuxTranslationDirection %u \
+\nBlit command. width: %u, height: %u, srcAddr: %#" SCNx64 ", dstAddr: %#" SCNx64 " \
+\nBlit command. width: %u, height: %u, srcAddr: %#" SCNx64 ", dstAddr: %#" SCNx64 " ",
+             static_cast<uint32_t>(AuxTranslationDirection::None),
+             maxBlitWidth, 1, hostPtrAddr, bufferGpuAddr,
+             (copySize - maxBlitWidth), 1, ptrOffset(hostPtrAddr, maxBlitWidth), ptrOffset(bufferGpuAddr, maxBlitWidth));
+
+    EXPECT_THAT(output, testing::HasSubstr(std::string(expectedStr)));
+}
+
 HWTEST_TEMPLATED_F(BcsBufferTests, givenBcsSupportedWhenQueueIsBlockedThenDispatchBlitWhenUnblocked) {
     auto bcsCsr = static_cast<UltCommandStreamReceiver<FamilyType> *>(commandQueue->getBcsCommandStreamReceiver());
 

opencl/test/unit_test/test_files/igdrcl.config

@@ -200,4 +200,5 @@ PauseOnGpuMode = -1
 PrintTagAllocationAddress = 0
 DoNotFlushCaches = false
 UseBindlessMode = -1
-MediaVfeStateMaxSubSlices = -1
+MediaVfeStateMaxSubSlices = -1
+PrintBlitDispatchDetails = 0

shared/source/debug_settings/debug_variables_base.inl

@@ -111,6 +111,7 @@ DECLARE_DEBUG_VARIABLE(bool, PrintBOCreateDestroyResult, false, "tracks the resu
 DECLARE_DEBUG_VARIABLE(bool, PrintBOBindingResult, false, "tracks the result of binding and unbinding of BOs")
 DECLARE_DEBUG_VARIABLE(bool, PrintTagAllocationAddress, false, "Print tag allocation address for each engine")
 DECLARE_DEBUG_VARIABLE(bool, ProvideVerboseImplicitFlush, false, "provides verbose messages about implicit flush mechanism")
+DECLARE_DEBUG_VARIABLE(bool, PrintBlitDispatchDetails, false, "Print blit dispatch details")
 
 /*PERFORMANCE FLAGS*/
 DECLARE_DEBUG_VARIABLE(bool, DisableZeroCopyForBuffers, false, "When active all buffer allocations will not share memory with CPU.")

shared/source/helpers/aux_translation.h

@@ -11,7 +11,7 @@
 
 namespace NEO {
 
-enum class AuxTranslationDirection {
+enum class AuxTranslationDirection : uint32_t {
     None,
     AuxToNonAux,
     NonAuxToAux

shared/source/helpers/blit_commands_helper_base.inl

@@ -139,6 +139,9 @@ void BlitCommandsHelper<GfxFamily>::dispatchBlitCommandsForBufferPerRow(const Bl
     uint64_t width = 1;
     uint64_t height = 1;
 
+    PRINT_DEBUG_STRING(DebugManager.flags.PrintBlitDispatchDetails.get(), stdout,
+                       "\nBlit dispatch with AuxTranslationDirection %u ", static_cast<uint32_t>(blitProperties.auxTranslationDirection));
+
     for (uint64_t slice = 0; slice < blitProperties.copySize.z; slice++) {
         for (uint64_t row = 0; row < blitProperties.copySize.y; row++) {
             uint64_t offset = 0;
@@ -165,6 +168,9 @@ void BlitCommandsHelper<GfxFamily>::dispatchBlitCommandsForBufferPerRow(const Bl
                     auto dstAddr = calculateBlitCommandDestinationBaseAddress(blitProperties, offset, row, slice);
                     auto srcAddr = calculateBlitCommandSourceBaseAddress(blitProperties, offset, row, slice);
 
+                    PRINT_DEBUG_STRING(DebugManager.flags.PrintBlitDispatchDetails.get(), stdout,
+                                       "\nBlit command. width: %u, height: %u, srcAddr: %#llx, dstAddr: %#llx ", width, height, srcAddr, dstAddr);
+
                     bltCmd.setDestinationBaseAddress(dstAddr);
                     bltCmd.setSourceBaseAddress(srcAddr);