Add debug flag to disable cache flush

Related-To: NEO-5144

Change-Id: I29590d840a641dfcf3fc4d099ca84f196c8fdc1f
Signed-off-by: Zbigniew Zdanowicz <[email protected]>

Author: zzdanowicz

opencl/source/helpers/hardware_commands_helper_bdw_plus.inl

@@ -11,6 +11,8 @@
 #include "opencl/source/helpers/hardware_commands_helper.h"
 #include "opencl/source/kernel/kernel.h"
 
+#include "pipe_control_args.h"
+
 namespace NEO {
 
 template <typename GfxFamily>
@@ -153,12 +155,8 @@ void HardwareCommandsHelper<GfxFamily>::setInterfaceDescriptorOffset(
 
 template <typename GfxFamily>
 void HardwareCommandsHelper<GfxFamily>::programCacheFlushAfterWalkerCommand(LinearStream *commandStream, const CommandQueue &commandQueue, const Kernel *kernel, uint64_t postSyncAddress) {
-    using PIPE_CONTROL = typename GfxFamily::PIPE_CONTROL;
-    auto pipeControl = commandStream->getSpaceForCmd<PIPE_CONTROL>();
-    PIPE_CONTROL cmd = GfxFamily::cmdInitPipeControl;
-    cmd.setCommandStreamerStallEnable(true);
-    cmd.setDcFlushEnable(true);
-    *pipeControl = cmd;
+    PipeControlArgs args(true);
+    MemorySynchronizationCommands<GfxFamily>::addPipeControl(*commandStream, args);
 }
 
 } // namespace NEO

opencl/test/unit_test/command_stream/command_stream_receiver_flush_task_2_tests.cpp

@@ -894,6 +894,46 @@ HWTEST_F(UltCommandStreamReceiverTest, addPipeControlWithFlushAllCaches) {
     EXPECT_TRUE(pipeControl->getStateCacheInvalidationEnable());
 }
 
+HWTEST_F(UltCommandStreamReceiverTest, givenDebugDisablingCacheFlushWhenAddingPipeControlWithCacheFlushThenOverrideRequestAndDisableCacheFlushFlags) {
+    using PIPE_CONTROL = typename FamilyType::PIPE_CONTROL;
+    DebugManagerStateRestore dbgRestorer;
+    DebugManager.flags.DoNotFlushCaches.set(true);
+
+    char buff[sizeof(PIPE_CONTROL) * 3];
+    LinearStream stream(buff, sizeof(PIPE_CONTROL) * 3);
+
+    PipeControlArgs args(true);
+    args.constantCacheInvalidationEnable = true;
+    args.instructionCacheInvalidateEnable = true;
+    args.pipeControlFlushEnable = true;
+    args.renderTargetCacheFlushEnable = true;
+    args.stateCacheInvalidationEnable = true;
+    args.textureCacheInvalidationEnable = true;
+    args.vfCacheInvalidationEnable = true;
+
+    MemorySynchronizationCommands<FamilyType>::addPipeControl(stream, args);
+
+    parseCommands<FamilyType>(stream, 0);
+
+    PIPE_CONTROL *pipeControl = getCommand<PIPE_CONTROL>();
+
+    ASSERT_NE(nullptr, pipeControl);
+
+    // WA pipeControl added
+    if (cmdList.size() == 2) {
+        pipeControl++;
+    }
+
+    EXPECT_FALSE(pipeControl->getDcFlushEnable());
+    EXPECT_FALSE(pipeControl->getRenderTargetCacheFlushEnable());
+    EXPECT_FALSE(pipeControl->getInstructionCacheInvalidateEnable());
+    EXPECT_FALSE(pipeControl->getTextureCacheInvalidationEnable());
+    EXPECT_FALSE(pipeControl->getPipeControlFlushEnable());
+    EXPECT_FALSE(pipeControl->getVfCacheInvalidationEnable());
+    EXPECT_FALSE(pipeControl->getConstantCacheInvalidationEnable());
+    EXPECT_FALSE(pipeControl->getStateCacheInvalidationEnable());
+}
+
 HWCMDTEST_F(IGFX_GEN8_CORE, CommandStreamReceiverFlushTaskTests, givenEnabledPreemptionWhenFlushTaskCalledThenDontProgramMediaVfeStateAgain) {
     pDevice->setPreemptionMode(PreemptionMode::ThreadGroup);
     auto &csr = pDevice->getUltCommandStreamReceiver<FamilyType>();

opencl/test/unit_test/gen12lp/command_stream_receiver_hw_tests_gen12lp.inl

@@ -72,3 +72,56 @@ GEN12LPTEST_F(UltCommandStreamReceiverTest, givenStateBaseAddressWhenItIsRequire
     EXPECT_TRUE(pipeControlCmd->getDcFlushEnable());
     EXPECT_TRUE(pipeControlCmd->getHdcPipelineFlush());
 }
+
+using UltCommandStreamReceiverTestGen12Lp = UltCommandStreamReceiverTest;
+
+GEN12LPTEST_F(UltCommandStreamReceiverTestGen12Lp, givenDebugEnablingCacheFlushWhenAddingPipeControlWithoutCacheFlushThenOverrideRequestAndEnableCacheFlushFlags) {
+    using PIPE_CONTROL = typename FamilyType::PIPE_CONTROL;
+    DebugManagerStateRestore dbgRestorer;
+    DebugManager.flags.FlushAllCaches.set(true);
+
+    char buff[sizeof(PIPE_CONTROL) * 3];
+    LinearStream stream(buff, sizeof(PIPE_CONTROL) * 3);
+
+    PipeControlArgs args;
+    MemorySynchronizationCommands<FamilyType>::addPipeControl(stream, args);
+
+    parseCommands<FamilyType>(stream, 0);
+
+    PIPE_CONTROL *pipeControl = getCommand<PIPE_CONTROL>();
+
+    ASSERT_NE(nullptr, pipeControl);
+
+    // WA pipeControl added
+    if (cmdList.size() == 2) {
+        pipeControl++;
+    }
+
+    EXPECT_TRUE(pipeControl->getHdcPipelineFlush());
+}
+
+GEN12LPTEST_F(UltCommandStreamReceiverTestGen12Lp, givenDebugDisablingCacheFlushWhenAddingPipeControlWithCacheFlushThenOverrideRequestAndDisableCacheFlushFlags) {
+    using PIPE_CONTROL = typename FamilyType::PIPE_CONTROL;
+    DebugManagerStateRestore dbgRestorer;
+    DebugManager.flags.DoNotFlushCaches.set(true);
+
+    char buff[sizeof(PIPE_CONTROL) * 3];
+    LinearStream stream(buff, sizeof(PIPE_CONTROL) * 3);
+
+    PipeControlArgs args(true);
+    args.hdcPipelineFlush = true;
+    MemorySynchronizationCommands<FamilyType>::addPipeControl(stream, args);
+
+    parseCommands<FamilyType>(stream, 0);
+
+    PIPE_CONTROL *pipeControl = getCommand<PIPE_CONTROL>();
+
+    ASSERT_NE(nullptr, pipeControl);
+
+    // WA pipeControl added
+    if (cmdList.size() == 2) {
+        pipeControl++;
+    }
+
+    EXPECT_FALSE(pipeControl->getHdcPipelineFlush());
+}

opencl/test/unit_test/gen12lp/hw_helper_tests_gen12lp.inl

@@ -338,12 +338,12 @@ GEN12LPTEST_F(LriHelperTestsGen12Lp, whenProgrammingLriCommandThenExpectMmioRema
 using MemorySynchronizatiopCommandsTests = ::testing::Test;
 
 GEN12LPTEST_F(MemorySynchronizatiopCommandsTests, whenSettingCacheFlushExtraFieldsThenExpectHdcFlushSet) {
-    using PIPE_CONTROL = typename FamilyType::PIPE_CONTROL;
-    PIPE_CONTROL pipeControl = FamilyType::cmdInitPipeControl;
-    pipeControl.setConstantCacheInvalidationEnable(true);
-    MemorySynchronizationCommands<FamilyType>::setCacheFlushExtraProperties(pipeControl);
-    EXPECT_TRUE(pipeControl.getHdcPipelineFlush());
-    EXPECT_FALSE(pipeControl.getConstantCacheInvalidationEnable());
+    PipeControlArgs args;
+    args.constantCacheInvalidationEnable = true;
+
+    MemorySynchronizationCommands<FamilyType>::setCacheFlushExtraProperties(args);
+    EXPECT_TRUE(args.hdcPipelineFlush);
+    EXPECT_FALSE(args.constantCacheInvalidationEnable);
 }
 
 GEN12LPTEST_F(HwHelperTestGen12Lp, givenUnknownProductFamilyWhenGettingIsWorkaroundRequiredThenFalseIsReturned) {

opencl/test/unit_test/test_files/igdrcl.config

@@ -196,4 +196,5 @@ PerformImplicitFlushForNewResource = -1
 PerformImplicitFlushForIdleGpu = -1
 ProvideVerboseImplicitFlush = false
 PauseOnGpuMode = -1
-PrintTagAllocationAddress = 0
+PrintTagAllocationAddress = 0
+DoNotFlushCaches = false

shared/source/debug_settings/debug_variables_base.inl

@@ -40,6 +40,7 @@ DECLARE_DEBUG_VARIABLE(bool, DisableTimestampPacketOptimizations, false, "Alloca
 DECLARE_DEBUG_VARIABLE(bool, DisableCachingForStatefulBufferAccess, false, "Disable caching for stateful buffer access")
 DECLARE_DEBUG_VARIABLE(bool, EnableDebugBreak, true, "Enable DEBUG_BREAKs")
 DECLARE_DEBUG_VARIABLE(bool, FlushAllCaches, false, "pipe controls between enqueues flush all possible caches")
+DECLARE_DEBUG_VARIABLE(bool, DoNotFlushCaches, false, "clear all possible cache flush flags from pipe controls between enqueue flush")
 DECLARE_DEBUG_VARIABLE(bool, MakeEachEnqueueBlocking, false, "equivalent of finish after each enqueue")
 DECLARE_DEBUG_VARIABLE(bool, DisableResourceRecycling, false, "when set to true disables resource recycling optimization")
 DECLARE_DEBUG_VARIABLE(bool, ForceDispatchScheduler, false, "dispatches scheduler kernel instead of kernel enqueued")

shared/source/gen12lp/hw_helper_gen12lp.cpp

@@ -220,12 +220,19 @@ std::string HwHelperHw<Family>::getExtensions() const {
 template <>
 inline void MemorySynchronizationCommands<Family>::setPipeControlExtraProperties(PIPE_CONTROL &pipeControl, PipeControlArgs &args) {
     pipeControl.setHdcPipelineFlush(args.hdcPipelineFlush);
+
+    if (DebugManager.flags.FlushAllCaches.get()) {
+        pipeControl.setHdcPipelineFlush(true);
+    }
+    if (DebugManager.flags.DoNotFlushCaches.get()) {
+        pipeControl.setHdcPipelineFlush(false);
+    }
 }
 
 template <>
-void MemorySynchronizationCommands<Family>::setCacheFlushExtraProperties(Family::PIPE_CONTROL &pipeControl) {
-    pipeControl.setHdcPipelineFlush(true);
-    pipeControl.setConstantCacheInvalidationEnable(false);
+void MemorySynchronizationCommands<Family>::setCacheFlushExtraProperties(PipeControlArgs &args) {
+    args.hdcPipelineFlush = true;
+    args.constantCacheInvalidationEnable = false;
 }
 
 template <>

shared/source/helpers/hw_helper.h

@@ -362,7 +362,7 @@ struct MemorySynchronizationCommands {
     static void addPipeControlWithCSStallOnly(LinearStream &commandStream, PipeControlArgs &args);
 
     static void addFullCacheFlush(LinearStream &commandStream);
-    static void setCacheFlushExtraProperties(PIPE_CONTROL &pipeControl);
+    static void setCacheFlushExtraProperties(PipeControlArgs &args);
 
     static size_t getSizeForPipeControlWithPostSyncOperation(const HardwareInfo &hwInfo);
     static size_t getSizeForSinglePipeControl();

shared/source/helpers/hw_helper_base.inl

@@ -256,6 +256,16 @@ void MemorySynchronizationCommands<GfxFamily>::setPipeControl(typename GfxFamily
         pipeControl.setConstantCacheInvalidationEnable(true);
         pipeControl.setStateCacheInvalidationEnable(true);
     }
+    if (DebugManager.flags.DoNotFlushCaches.get()) {
+        pipeControl.setDcFlushEnable(false);
+        pipeControl.setRenderTargetCacheFlushEnable(false);
+        pipeControl.setInstructionCacheInvalidateEnable(false);
+        pipeControl.setTextureCacheInvalidationEnable(false);
+        pipeControl.setPipeControlFlushEnable(false);
+        pipeControl.setVfCacheInvalidationEnable(false);
+        pipeControl.setConstantCacheInvalidationEnable(false);
+        pipeControl.setStateCacheInvalidationEnable(false);
+    }
 }
 
 template <typename GfxFamily>
@@ -456,8 +466,8 @@ void MemorySynchronizationCommands<GfxFamily>::addFullCacheFlush(LinearStream &c
     args.pipeControlFlushEnable = true;
     args.constantCacheInvalidationEnable = true;
     args.stateCacheInvalidationEnable = true;
+    MemorySynchronizationCommands<GfxFamily>::setCacheFlushExtraProperties(args);
     MemorySynchronizationCommands<GfxFamily>::setPipeControl(cmd, args);
-    MemorySynchronizationCommands<GfxFamily>::setCacheFlushExtraProperties(cmd);
     *pipeControl = cmd;
 }
 

shared/source/helpers/hw_helper_bdw_plus.inl

@@ -103,7 +103,7 @@ inline void MemorySynchronizationCommands<GfxFamily>::setPostSyncExtraProperties
 }
 
 template <typename GfxFamily>
-inline void MemorySynchronizationCommands<GfxFamily>::setCacheFlushExtraProperties(PIPE_CONTROL &pipeControl) {
+inline void MemorySynchronizationCommands<GfxFamily>::setCacheFlushExtraProperties(PipeControlArgs &args) {
 }
 
 template <typename GfxFamily>