Disable L3 caches for debug on ATS and DG2

ivvenevt · Compute-Runtime-Automation · commit fe250d99b19b · 2021-12-14T13:59:09.000+01:00
Resolves: NEO-6320

Signed-off-by: Igor Venevtsev &lt;igor.venevtsev@intel.com&gt;
diff --git a/level_zero/core/source/debugger/debugger_l0.cpp b/level_zero/core/source/debugger/debugger_l0.cpp
@@ -78,6 +78,9 @@ void DebuggerL0::initialize() {
         NEO::MemoryTransferHelper::transferMemoryToAllocation(hwHelper.isBlitCopyRequiredForLocalMemory(hwInfo, *moduleDebugArea),
                                                               *device, moduleDebugArea, 0, &debugArea,
                                                               sizeof(DebugAreaHeader));
+        if (hwHelper.disableL3CacheForDebug()) {
+            device->getGmmHelper()->disableL3CacheForDebug();
+        }
     }
 }
 
diff --git a/level_zero/core/test/unit_tests/sources/debugger/test_l0_debugger.cpp b/level_zero/core/test/unit_tests/sources/debugger/test_l0_debugger.cpp
@@ -7,13 +7,13 @@
 
 #include "shared/source/command_stream/linear_stream.h"
 #include "shared/source/gen_common/reg_configs_common.h"
-#include "shared/source/gmm_helper/gmm_helper.h"
 #include "shared/source/helpers/blit_commands_helper.h"
 #include "shared/source/helpers/preamble.h"
 #include "shared/source/memory_manager/graphics_allocation.h"
 #include "shared/source/os_interface/os_context.h"
 #include "shared/test/common/cmd_parse/gen_cmd_parse.h"
 #include "shared/test/common/helpers/variable_backup.h"
+#include "shared/test/common/mocks/mock_gmm_helper.h"
 
 #include "test.h"
 
@@ -1634,5 +1634,14 @@ TEST(Debugger, givenNonLegacyDebuggerWhenInitializingDeviceCapsThenUnrecoverable
     EXPECT_THROW(NEO::MockDevice::create<NEO::MockDevice>(executionEnvironment, 0u), std::exception);
 }
 
+using NotATSOrDG2 = AreNotGfxCores<IGFX_XE_HP_CORE, IGFX_XE_HPG_CORE>;
+HWTEST2_F(L0DebuggerTest, givenNotAtsOrDg2AndDebugIsActiveThenDisableL3CacheInGmmHelperIsNotSet, NotATSOrDG2) {
+    EXPECT_FALSE(static_cast<MockGmmHelper *>(neoDevice->getGmmHelper())->l3CacheForDebugDisabled);
+}
+
+using ATSOrDG2 = IsWithinGfxCore<IGFX_XE_HP_CORE, IGFX_XE_HPG_CORE>;
+HWTEST2_F(L0DebuggerTest, givenAtsOrDg2AndDebugIsActiveThenDisableL3CacheInGmmHelperIsSet, ATSOrDG2) {
+    EXPECT_TRUE(static_cast<MockGmmHelper *>(neoDevice->getGmmHelper())->l3CacheForDebugDisabled);
+}
 } // namespace ult
 } // namespace L0
diff --git a/opencl/test/unit_test/gmm_helper/gmm_helper_tests.cpp b/opencl/test/unit_test/gmm_helper/gmm_helper_tests.cpp
@@ -865,6 +865,34 @@ TEST(GmmHelperTest, givenValidGmmFunctionsWhenCreateGmmHelperWithoutOsInterfaceT
     EXPECT_EQ(GMM_CLIENT::GMM_OCL_VISTA, passedInputArgs.ClientType);
 }
 
+TEST(GmmHelperTest, givenGmmHelperAndL3CacheDisabledForDebugThenCorrectMOCSIsReturned) {
+    decltype(GmmHelper::createGmmContextWrapperFunc) createGmmContextSave = GmmHelper::createGmmContextWrapperFunc;
+    GmmHelper::createGmmContextWrapperFunc = GmmClientContext::create<MockGmmClientContext>;
+
+    std::unique_ptr<GmmHelper> gmmHelper;
+    auto hwInfo = defaultHwInfo.get();
+    gmmHelper.reset(new GmmHelper(nullptr, hwInfo));
+
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_BUFFER_CACHELINE_MISALIGNED));
+    EXPECT_EQ(2u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_STATE_HEAP_BUFFER));
+    EXPECT_EQ(4u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_IMAGE));
+    EXPECT_EQ(4u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_IMAGE_FROM_BUFFER));
+    EXPECT_EQ(8u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_BUFFER_CONST));
+    EXPECT_EQ(16u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_BUFFER));
+    EXPECT_EQ(32u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_INLINE_CONST_HDC));
+
+    gmmHelper->disableL3CacheForDebug();
+
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_BUFFER_CACHELINE_MISALIGNED));
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_STATE_HEAP_BUFFER));
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_IMAGE));
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_IMAGE_FROM_BUFFER));
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_BUFFER_CONST));
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_BUFFER));
+    EXPECT_EQ(0u, gmmHelper->getMOCS(GMM_RESOURCE_USAGE_OCL_INLINE_CONST_HDC));
+    GmmHelper::createGmmContextWrapperFunc = createGmmContextSave;
+}
+
 struct GmmCompressionTests : public MockExecutionEnvironmentGmmFixtureTest {
     void SetUp() override {
         MockExecutionEnvironmentGmmFixtureTest::SetUp();
diff --git a/opencl/test/unit_test/helpers/hw_helper_tests.cpp b/opencl/test/unit_test/helpers/hw_helper_tests.cpp
@@ -1397,3 +1397,15 @@ TEST(HwHelperTests, whenBlitterSupportIsDisabledThenDontExposeAnyBcsEngine) {
         EXPECT_FALSE(EngineHelpers::isBcs(engineUsageType.first));
     }
 }
+
+using NotATSOrDG2 = AreNotGfxCores<IGFX_XE_HP_CORE, IGFX_XE_HPG_CORE>;
+HWTEST2_F(HwHelperTest, givenNotAtsOrDg2WhenDisableL3ForDebugCalledThenFalseIsReturned, NotATSOrDG2) {
+    const auto &hwHelper = HwHelper::get(renderCoreFamily);
+    EXPECT_FALSE(hwHelper.disableL3CacheForDebug());
+}
+
+using ATSOrDG2 = IsWithinGfxCore<IGFX_XE_HP_CORE, IGFX_XE_HPG_CORE>;
+HWTEST2_F(HwHelperTest, givenAtsOrDg2WhenDisableL3ForDebugCalledThenTrueIsReturned, ATSOrDG2) {
+    const auto &hwHelper = HwHelper::get(renderCoreFamily);
+    EXPECT_TRUE(hwHelper.disableL3CacheForDebug());
+}
diff --git a/opencl/test/unit_test/os_interface/linux/drm_buffer_object_tests.cpp b/opencl/test/unit_test/os_interface/linux/drm_buffer_object_tests.cpp
@@ -15,6 +15,7 @@
 #include "shared/test/common/mocks/linux/mock_drm_allocation.h"
 #include "shared/test/common/mocks/mock_device.h"
 #include "shared/test/common/mocks/mock_execution_environment.h"
+#include "shared/test/common/mocks/mock_gmm_helper.h"
 #include "shared/test/common/os_interface/linux/device_command_stream_fixture.h"
 
 #include "test.h"
@@ -501,10 +502,6 @@ TEST_F(DrmBufferObjectTest, givenAsyncDebugFlagWhenFillingExecObjectThenFlagIsSe
     EXPECT_TRUE(execObject.flags & EXEC_OBJECT_ASYNC);
 }
 
-struct MockGmmHelper : GmmHelper {
-    using GmmHelper::addressWidth;
-};
-
 TEST_F(DrmBufferObjectTest, given47bitAddressWhenSetThenIsAddressNotCanonized) {
     VariableBackup<uint32_t> backup(&MockGmmHelper::addressWidth, 48);
 
diff --git a/opencl/test/unit_test/source_level_debugger/source_level_debugger_tests.cpp b/opencl/test/unit_test/source_level_debugger/source_level_debugger_tests.cpp
@@ -15,14 +15,14 @@
 #include "shared/test/common/helpers/ult_hw_config.h"
 #include "shared/test/common/helpers/variable_backup.h"
 #include "shared/test/common/libult/source_level_debugger_library.h"
+#include "shared/test/common/mocks/mock_gmm_helper.h"
 #include "shared/test/common/mocks/mock_source_level_debugger.h"
 
 #include "opencl/source/platform/platform.h"
 #include "opencl/test/unit_test/helpers/execution_environment_helper.h"
 #include "opencl/test/unit_test/mocks/mock_cl_device.h"
 #include "opencl/test/unit_test/mocks/mock_platform.h"
-
-#include <gtest/gtest.h>
+#include "test.h"
 
 #include <memory>
 #include <string>
@@ -700,7 +700,6 @@ TEST(SourceLevelDebugger, givenEnableMockSourceLevelDebuggerWhenInitializingExec
     DebuggerLibrary::setLibraryAvailable(false);
 
     DebugManager.flags.EnableMockSourceLevelDebugger.set(1);
-
     auto executionEnvironment = new ExecutionEnvironment();
     MockPlatform platform(*executionEnvironment);
     platform.initializeWithNewDevices();
@@ -856,4 +855,28 @@ TEST(SourceLevelDebugger, givenDebuggerLibraryAvailableAndExperimentalEnableSour
     auto debugger = std::unique_ptr<Debugger>(Debugger::create(&hwInfo));
     ASSERT_NE(nullptr, debugger.get());
     EXPECT_TRUE(debugger->isLegacy());
-}
+}
+
+using LegacyDebuggerTest = ::testing::Test;
+
+using NotATSOrDG2 = AreNotGfxCores<IGFX_XE_HP_CORE, IGFX_XE_HPG_CORE>;
+HWTEST2_F(LegacyDebuggerTest, givenNotAtsOrDg2AndDebugIsActiveThenDisableL3CacheInGmmHelperIsNotSet, NotATSOrDG2) {
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.EnableMockSourceLevelDebugger.set(1);
+    auto executionEnvironment = new ExecutionEnvironment();
+    MockPlatform platform(*executionEnvironment);
+    platform.initializeWithNewDevices();
+
+    EXPECT_FALSE(static_cast<MockGmmHelper *>(platform.getClDevice(0)->getDevice().getGmmHelper())->l3CacheForDebugDisabled);
+}
+
+using ATSOrDG2 = IsWithinGfxCore<IGFX_XE_HP_CORE, IGFX_XE_HPG_CORE>;
+HWTEST2_F(LegacyDebuggerTest, givenAtsOrDg2AndDebugIsActiveThenDisableL3CacheInGmmHelperIsSet, ATSOrDG2) {
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.EnableMockSourceLevelDebugger.set(1);
+    auto executionEnvironment = new ExecutionEnvironment();
+    MockPlatform platform(*executionEnvironment);
+    platform.initializeWithNewDevices();
+
+    EXPECT_TRUE(static_cast<MockGmmHelper *>(platform.getClDevice(0)->getDevice().getGmmHelper())->l3CacheForDebugDisabled);
+}
diff --git a/shared/source/device/device.cpp b/shared/source/device/device.cpp
@@ -222,6 +222,11 @@ bool Device::createDeviceImpl() {
         this->executionEnvironment->rootDeviceEnvironments[getRootDeviceIndex()]->initDebugger();
     }
 
+    auto &hwHelper = HwHelper::get(hwInfo.platform.eRenderCoreFamily);
+    if (getDebugger() && hwHelper.disableL3CacheForDebug()) {
+        getGmmHelper()->disableL3CacheForDebug();
+    }
+
     if (!createEngines()) {
         return false;
     }
diff --git a/shared/source/gmm_helper/gmm_helper.cpp b/shared/source/gmm_helper/gmm_helper.cpp
@@ -30,6 +30,10 @@ const HardwareInfo *GmmHelper::getHardwareInfo() {
 }
 
 uint32_t GmmHelper::getMOCS(uint32_t type) const {
+    if (l3CacheForDebugDisabled) {
+        type = GMM_RESOURCE_USAGE_OCL_BUFFER_CACHELINE_MISALIGNED;
+    }
+
     MEMORY_OBJECT_CONTROL_STATE mocs = gmmClientContext->cachePolicyGetMemoryObject(nullptr, static_cast<GMM_RESOURCE_USAGE_TYPE>(type));
 
     return static_cast<uint32_t>(mocs.DwordValue);
diff --git a/shared/source/gmm_helper/gmm_helper.h b/shared/source/gmm_helper/gmm_helper.h
@@ -23,6 +23,7 @@ class GmmHelper {
 
     const HardwareInfo *getHardwareInfo();
     uint32_t getMOCS(uint32_t type) const;
+    void disableL3CacheForDebug() { l3CacheForDebugDisabled = true; };
 
     static constexpr uint64_t maxPossiblePitch = (1ull << 31);
 
@@ -42,5 +43,6 @@ class GmmHelper {
     static uint32_t addressWidth;
     const HardwareInfo *hwInfo = nullptr;
     std::unique_ptr<GmmClientContext> gmmClientContext;
+    bool l3CacheForDebugDisabled = false;
 };
 } // namespace NEO
diff --git a/shared/source/helpers/hw_helper.h b/shared/source/helpers/hw_helper.h
@@ -150,6 +150,7 @@ class HwHelper {
     virtual uint64_t getMaxMemAllocSize() const = 0;
     virtual bool isStatelesToStatefullWithOffsetSupported() const = 0;
     virtual void encodeBufferSurfaceState(EncodeSurfaceStateArgs &args) = 0;
+    virtual bool disableL3CacheForDebug() const = 0;
 
   protected:
     HwHelper() = default;
@@ -381,6 +382,7 @@ class HwHelperHw : public HwHelper {
     uint64_t getMaxMemAllocSize() const override;
     bool isStatelesToStatefullWithOffsetSupported() const override;
     void encodeBufferSurfaceState(EncodeSurfaceStateArgs &args) override;
+    bool disableL3CacheForDebug() const override;
 
   protected:
     static const AuxTranslationMode defaultAuxTranslationMode;
diff --git a/shared/source/helpers/hw_helper_base.inl b/shared/source/helpers/hw_helper_base.inl
@@ -700,4 +700,8 @@ void HwHelperHw<GfxFamily>::encodeBufferSurfaceState(EncodeSurfaceStateArgs &arg
     EncodeSurfaceState<GfxFamily>::encodeBuffer(args);
 }
 
+template <typename GfxFamily>
+bool HwHelperHw<GfxFamily>::disableL3CacheForDebug() const {
+    return false;
+}
 } // namespace NEO
diff --git a/shared/source/xe_hp_core/hw_helper_xe_hp_core.cpp b/shared/source/xe_hp_core/hw_helper_xe_hp_core.cpp
@@ -154,6 +154,11 @@ uint32_t HwHelperHw<Family>::getDefaultRevisionId(const HardwareInfo &hwInfo) co
     return HwInfoConfig::get(hwInfo.platform.eProductFamily)->getHwRevIdFromStepping(REVISION_B, hwInfo);
 }
 
+template <>
+bool HwHelperHw<Family>::disableL3CacheForDebug() const {
+    return true;
+}
+
 template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
diff --git a/shared/source/xe_hpg_core/hw_helper_xe_hpg_core.cpp b/shared/source/xe_hpg_core/hw_helper_xe_hpg_core.cpp
@@ -113,6 +113,11 @@ uint32_t HwHelperHw<Family>::computeSlmValues(const HardwareInfo &hwInfo, uint32
     return slmValue;
 }
 
+template <>
+bool HwHelperHw<Family>::disableL3CacheForDebug() const {
+    return true;
+}
+
 template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
diff --git a/shared/test/common/mocks/mock_gmm_helper.h b/shared/test/common/mocks/mock_gmm_helper.h
@@ -0,0 +1,16 @@
+/*
+ * Copyright (C) 2021 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+
+#pragma once
+#include "shared/source/gmm_helper/gmm_helper.h"
+
+namespace NEO {
+struct MockGmmHelper : GmmHelper {
+    using GmmHelper::addressWidth;
+    using GmmHelper::l3CacheForDebugDisabled;
+};
+} // namespace NEO

Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,9 @@ void DebuggerL0::initialize() {`
`78`	`78`	`NEO::MemoryTransferHelper::transferMemoryToAllocation(hwHelper.isBlitCopyRequiredForLocalMemory(hwInfo, *moduleDebugArea),`
`79`	`79`	`*device, moduleDebugArea, 0, &debugArea,`
`80`	`80`	`sizeof(DebugAreaHeader));`
	`81`	`+ if (hwHelper.disableL3CacheForDebug()) {`
	`82`	`+ device->getGmmHelper()->disableL3CacheForDebug();`
	`83`	`+ }`
`81`	`84`	`}`
`82`	`85`	`}`
`83`	`86`
Original file line number	Diff line number	Diff line change
`@@ -222,6 +222,11 @@ bool Device::createDeviceImpl() {`
`222`	`222`	`this->executionEnvironment->rootDeviceEnvironments[getRootDeviceIndex()]->initDebugger();`
`223`	`223`	`}`
`224`	`224`
	`225`	`+ auto &hwHelper = HwHelper::get(hwInfo.platform.eRenderCoreFamily);`
	`226`	`+ if (getDebugger() && hwHelper.disableL3CacheForDebug()) {`
	`227`	`+ getGmmHelper()->disableL3CacheForDebug();`
	`228`	`+ }`
	`229`	`+`
`225`	`230`	`if (!createEngines()) {`
`226`	`231`	`return false;`
`227`	`232`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,10 @@ const HardwareInfo *GmmHelper::getHardwareInfo() {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`uint32_t GmmHelper::getMOCS(uint32_t type) const {`
	`33`	`+ if (l3CacheForDebugDisabled) {`
	`34`	`+ type = GMM_RESOURCE_USAGE_OCL_BUFFER_CACHELINE_MISALIGNED;`
	`35`	`+ }`
	`36`	`+`
`33`	`37`	`MEMORY_OBJECT_CONTROL_STATE mocs = gmmClientContext->cachePolicyGetMemoryObject(nullptr, static_cast<GMM_RESOURCE_USAGE_TYPE>(type));`
`34`	`38`
`35`	`39`	`return static_cast<uint32_t>(mocs.DwordValue);`