From 4798c8a324b23e5bf9a6014af61f68df8efb45e1 Mon Sep 17 00:00:00 2001
From: Lukasz Jobczyk <lukasz.jobczyk@intel.com>
Date: Wed, 9 Nov 2022 14:43:02 +0000
Subject: [PATCH] Add sfence when stop ring buffer

Signed-off-by: Lukasz Jobczyk <lukasz.jobczyk@intel.com>

Source: 5011046a1773e0a0e9bcbb283cdd68c6803ccc69
---
 .../direct_submission/direct_submission_hw.h  |  1 +
 .../direct_submission_hw.inl                  | 27 ++++++++++---------
 .../direct_submission_tests_2.cpp             | 23 ++++++++++++++++
 3 files changed, 39 insertions(+), 12 deletions(-)

diff --git a/shared/source/direct_submission/direct_submission_hw.h b/shared/source/direct_submission/direct_submission_hw.h
index 7e6e2a3bb8278..241f29e95752a 100644
--- a/shared/source/direct_submission/direct_submission_hw.h
+++ b/shared/source/direct_submission/direct_submission_hw.h
@@ -107,6 +107,7 @@ class DirectSubmissionHw {
     GraphicsAllocation *switchRingBuffersAllocations();
     virtual uint64_t updateTagValue() = 0;
     virtual void getTagAddressValue(TagData &tagData) = 0;
+    void unblockGpu();
 
     void cpuCachelineFlush(void *ptr, size_t size);
 
diff --git a/shared/source/direct_submission/direct_submission_hw.inl b/shared/source/direct_submission/direct_submission_hw.inl
index de57f11e4b007..cf59f1f7affda 100644
--- a/shared/source/direct_submission/direct_submission_hw.inl
+++ b/shared/source/direct_submission/direct_submission_hw.inl
@@ -159,6 +159,19 @@ bool DirectSubmissionHw<GfxFamily, Dispatcher>::makeResourcesResident(DirectSubm
     return ret;
 }
 
+template <typename GfxFamily, typename Dispatcher>
+inline void DirectSubmissionHw<GfxFamily, Dispatcher>::unblockGpu() {
+    if (sfenceMode >= DirectSubmissionSfenceMode::BeforeSemaphoreOnly) {
+        CpuIntrinsics::sfence();
+    }
+
+    semaphoreData->QueueWorkCount = currentQueueWorkCount;
+
+    if (sfenceMode == DirectSubmissionSfenceMode::BeforeAndAfterSemaphore) {
+        CpuIntrinsics::sfence();
+    }
+}
+
 template <typename GfxFamily, typename Dispatcher>
 inline void DirectSubmissionHw<GfxFamily, Dispatcher>::cpuCachelineFlush(void *ptr, size_t size) {
     if (disableCpuCacheFlush) {
@@ -273,8 +286,7 @@ bool DirectSubmissionHw<GfxFamily, Dispatcher>::stopRingBuffer() {
     EncodeNoop<GfxFamily>::alignToCacheLine(ringCommandStream);
 
     cpuCachelineFlush(flushPtr, getSizeEnd());
-
-    semaphoreData->QueueWorkCount = currentQueueWorkCount;
+    this->unblockGpu();
     cpuCachelineFlush(semaphorePtr, MemoryConstants::cacheLineSize);
 
     this->handleStopRingBuffer();
@@ -478,16 +490,7 @@ bool DirectSubmissionHw<GfxFamily, Dispatcher>::dispatchCommandBuffer(BatchBuffe
         reserved = *ringBufferStart;
     }
 
-    if (sfenceMode >= DirectSubmissionSfenceMode::BeforeSemaphoreOnly) {
-        CpuIntrinsics::sfence();
-    }
-
-    //unblock GPU
-    semaphoreData->QueueWorkCount = currentQueueWorkCount;
-
-    if (sfenceMode == DirectSubmissionSfenceMode::BeforeAndAfterSemaphore) {
-        CpuIntrinsics::sfence();
-    }
+    this->unblockGpu();
 
     cpuCachelineFlush(semaphorePtr, MemoryConstants::cacheLineSize);
     currentQueueWorkCount++;
diff --git a/shared/test/unit_test/direct_submission/direct_submission_tests_2.cpp b/shared/test/unit_test/direct_submission/direct_submission_tests_2.cpp
index 22f6062675392..8281426eb0299 100644
--- a/shared/test/unit_test/direct_submission/direct_submission_tests_2.cpp
+++ b/shared/test/unit_test/direct_submission/direct_submission_tests_2.cpp
@@ -879,3 +879,26 @@ HWTEST_F(DirectSubmissionDispatchBufferTest, givenDebugFlagSetWhenDispatchingWor
         EXPECT_EQ(initialCounterValue + expectedCount, CpuIntrinsicsTests::sfenceCounter);
     }
 }
+
+HWTEST_F(DirectSubmissionDispatchBufferTest, givenDebugFlagSetWhenStoppingRingbufferThenProgramSfenceInstruction) {
+    DebugManagerStateRestore restorer{};
+
+    using Dispatcher = BlitterDispatcher<FamilyType>;
+
+    FlushStampTracker flushStamp(true);
+
+    for (int32_t debugFlag : {-1, 0, 1, 2}) {
+        DebugManager.flags.DirectSubmissionInsertSfenceInstructionPriorToSubmission.set(debugFlag);
+
+        MockDirectSubmissionHw<FamilyType, Dispatcher> directSubmission(*pDevice->getDefaultEngine().commandStreamReceiver);
+        EXPECT_TRUE(directSubmission.initialize(true, true));
+
+        auto initialCounterValue = CpuIntrinsicsTests::sfenceCounter.load();
+
+        EXPECT_TRUE(directSubmission.stopRingBuffer());
+
+        uint32_t expectedCount = (debugFlag == -1) ? 2 : static_cast<uint32_t>(debugFlag);
+
+        EXPECT_EQ(initialCounterValue + expectedCount, CpuIntrinsicsTests::sfenceCounter);
+    }
+}
\ No newline at end of file