feature: add isTranslationExceptionSupported method

Related-To: NEO-7782

Signed-off-by: Rafal Maziejuk <[email protected]>

Author: RafalMaziejukIntel

opencl/test/unit_test/source_level_debugger/source_level_debugger_tests.cpp

@@ -125,6 +125,7 @@ void StateComputeModeProperties::setThreadArbitrationProperty(int32_t threadArbi
 void StateComputeModeProperties::initSupport(const RootDeviceEnvironment &rootDeviceEnvironment) {
     auto &productHelper = rootDeviceEnvironment.getHelper<ProductHelper>();
     productHelper.fillScmPropertiesSupportStructure(this->scmPropertiesSupport);
+    productHelper.fillScmPropertiesSupportStructureExtra(this->scmPropertiesSupport, rootDeviceEnvironment);
 
     auto &gfxCoreHelper = rootDeviceEnvironment.getHelper<GfxCoreHelper>();
     this->defaultThreadArbitrationPolicy = gfxCoreHelper.getDefaultThreadArbitrationPolicy();

shared/source/command_stream/stream_properties.cpp

@@ -169,6 +169,7 @@ class ProductHelper {
     virtual bool isDummyBlitWaRequired() const = 0;
     virtual bool isDetectIndirectAccessInKernelSupported(const KernelDescriptor &kernelDescriptor) const = 0;
     virtual bool isLinearStoragePreferred(bool isSharedContext, bool isImage1d, bool forceLinearStorage) const = 0;
+    virtual bool isTranslationExceptionSupported() const = 0;
 
     virtual bool getFrontEndPropertyScratchSizeSupport() const = 0;
     virtual bool getFrontEndPropertyPrivateScratchSizeSupport() const = 0;
@@ -195,6 +196,7 @@ class ProductHelper {
     virtual bool getPipelineSelectPropertySystolicModeSupport() const = 0;
 
     virtual void fillScmPropertiesSupportStructure(StateComputeModePropertiesSupport &propertiesSupport) const = 0;
+    virtual void fillScmPropertiesSupportStructureExtra(StateComputeModePropertiesSupport &propertiesSupport, const RootDeviceEnvironment &rootDeviceEnvironment) const = 0;
     virtual void fillFrontEndPropertiesSupportStructure(FrontEndPropertiesSupport &propertiesSupport, const HardwareInfo &hwInfo) const = 0;
     virtual void fillPipelineSelectPropertiesSupportStructure(PipelineSelectPropertiesSupport &propertiesSupport, const HardwareInfo &hwInfo) const = 0;
     virtual void fillStateBaseAddressPropertiesSupportStructure(StateBaseAddressPropertiesSupport &propertiesSupport) const = 0;

shared/source/os_interface/product_helper.h

@@ -604,6 +604,9 @@ void ProductHelperHw<gfxProduct>::fillScmPropertiesSupportStructure(StateCompute
     fillScmPropertiesSupportStructureBase(propertiesSupport);
 }
 
+template <PRODUCT_FAMILY gfxProduct>
+void ProductHelperHw<gfxProduct>::fillScmPropertiesSupportStructureExtra(StateComputeModePropertiesSupport &propertiesSupport, const RootDeviceEnvironment &rootDeviceEnvironment) const {}
+
 template <PRODUCT_FAMILY gfxProduct>
 bool ProductHelperHw<gfxProduct>::getScmPropertyThreadArbitrationPolicySupport() const {
     using GfxProduct = typename HwMapper<gfxProduct>::GfxProduct;
@@ -775,4 +778,10 @@ bool ProductHelperHw<gfxProduct>::isLinearStoragePreferred(bool isSharedContext,
     }
     return false;
 }
+
+template <PRODUCT_FAMILY gfxProduct>
+bool ProductHelperHw<gfxProduct>::isTranslationExceptionSupported() const {
+    return false;
+}
+
 } // namespace NEO

shared/source/os_interface/product_helper.inl

@@ -123,6 +123,7 @@ class ProductHelperHw : public ProductHelper {
     bool isDummyBlitWaRequired() const override;
     bool isDetectIndirectAccessInKernelSupported(const KernelDescriptor &kernelDescriptor) const override;
     bool isLinearStoragePreferred(bool isSharedContext, bool isImage1d, bool forceLinearStorage) const override;
+    bool isTranslationExceptionSupported() const override;
 
     bool getFrontEndPropertyScratchSizeSupport() const override;
     bool getFrontEndPropertyPrivateScratchSizeSupport() const override;
@@ -149,6 +150,7 @@ class ProductHelperHw : public ProductHelper {
     bool getPipelineSelectPropertySystolicModeSupport() const override;
 
     void fillScmPropertiesSupportStructure(StateComputeModePropertiesSupport &propertiesSupport) const override;
+    void fillScmPropertiesSupportStructureExtra(StateComputeModePropertiesSupport &propertiesSupport, const RootDeviceEnvironment &rootDeviceEnvironment) const override;
     void fillFrontEndPropertiesSupportStructure(FrontEndPropertiesSupport &propertiesSupport, const HardwareInfo &hwInfo) const override;
     void fillPipelineSelectPropertiesSupportStructure(PipelineSelectPropertiesSupport &propertiesSupport, const HardwareInfo &hwInfo) const override;
     void fillStateBaseAddressPropertiesSupportStructure(StateBaseAddressPropertiesSupport &propertiesSupport) const override;

shared/source/os_interface/product_helper_hw.h

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2023 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+
+#pragma once
+
+#include "shared/test/common/libult/source_level_debugger_library.h"
+
+namespace NEO {
+
+class DebuggerLibraryRestore {
+  public:
+    DebuggerLibraryRestore() {
+        restoreActiveState = DebuggerLibrary::getDebuggerActive();
+        restoreAvailableState = DebuggerLibrary::getLibraryAvailable();
+    }
+    ~DebuggerLibraryRestore() {
+        DebuggerLibrary::clearDebuggerLibraryInterceptor();
+        DebuggerLibrary::setDebuggerActive(restoreActiveState);
+        DebuggerLibrary::setLibraryAvailable(restoreAvailableState);
+    }
+
+    bool restoreActiveState = false;
+    bool restoreAvailableState = false;
+};
+
+} // namespace NEO

shared/test/common/helpers/debugger_library_restore.h

@@ -62,6 +62,8 @@ struct UnitTestHelper {
     static uint32_t getTdCtlRegisterOffset();
     static uint32_t getTdCtlRegisterValue();
 
+    static uint32_t getMiLoadRegisterImmProgrammedCmdsCount(bool debuggingEnabled);
+
     static const uint32_t smallestTestableSimdSize;
 
     static const AuxTranslationMode requiredAuxTranslationMode;

shared/test/common/helpers/unit_test_helper.h

@@ -108,4 +108,9 @@ uint32_t UnitTestHelper<GfxFamily>::getProgrammedGrfValue(CommandStreamReceiver
     return 0u;
 }
 
+template <typename GfxFamily>
+uint32_t UnitTestHelper<GfxFamily>::getMiLoadRegisterImmProgrammedCmdsCount(bool debuggingEnabled) {
+    return (debuggingEnabled ? 2u : 0u);
+}
+
 } // namespace NEO

shared/test/common/helpers/unit_test_helper.inl

@@ -123,6 +123,7 @@ HWTEST2_F(StreamPropertiesTests, whenSettingStateComputeModePropertiesThenCorrec
     auto &rootDeviceEnvironment = *executionEnvironment.rootDeviceEnvironments[0];
     auto &productHelper = rootDeviceEnvironment.getHelper<ProductHelper>();
     productHelper.fillScmPropertiesSupportStructure(scmPropertiesSupport);
+    productHelper.fillScmPropertiesSupportStructureExtra(scmPropertiesSupport, rootDeviceEnvironment);
 
     int32_t threadArbitrationPolicyValues[] = {
         ThreadArbitrationPolicy::AgeBased, ThreadArbitrationPolicy::RoundRobin,

shared/test/unit_test/command_stream/stream_properties_tests_common.cpp

@@ -12,6 +12,7 @@
 #include "shared/source/helpers/gfx_core_helper.h"
 #include "shared/test/common/fixtures/preamble_fixture.h"
 #include "shared/test/common/helpers/debug_manager_state_restore.h"
+#include "shared/test/common/helpers/unit_test_helper.h"
 #include "shared/test/common/mocks/mock_execution_environment.h"
 #include "shared/test/common/test_macros/header/per_product_test_definitions.h"
 
@@ -194,7 +195,8 @@ GEN11TEST_F(PreambleFixtureGen11, whenKernelDebuggingCommandsAreProgrammedThenCo
     hwParser.parseCommands<FamilyType>(stream);
     auto cmdList = hwParser.getCommandsList<MI_LOAD_REGISTER_IMM>();
 
-    ASSERT_EQ(2u, cmdList.size());
+    auto expectedProgrammedCmdsCount = UnitTestHelper<FamilyType>::getMiLoadRegisterImmProgrammedCmdsCount(true);
+    ASSERT_EQ(expectedProgrammedCmdsCount, cmdList.size());
 
     auto it = cmdList.begin();
 

shared/test/unit_test/gen11/test_preamble_gen11.cpp

@@ -747,3 +747,7 @@ HWTEST_F(ProductHelperTest, givenProductHelperAndKernelBinaryFormatsWhenChecking
         EXPECT_FALSE(productHelper->isDetectIndirectAccessInKernelSupported(kernelDescriptor));
     }
 }
+
+HWTEST_F(ProductHelperTest, givenProductHelperWhenCheckingIsTranslationExceptionSupportedThenReturnFalse) {
+    EXPECT_FALSE(productHelper->isTranslationExceptionSupported());
+}

shared/test/unit_test/os_interface/product_helper_tests.cpp

@@ -97,10 +97,12 @@ HWCMDTEST_F(IGFX_GEN8_CORE, PreambleTest, givenMidThreadPreemptionWhenPreambleIs
 }
 
 HWTEST_F(PreambleTest, givenActiveKernelDebuggingWhenPreambleKernelDebuggingCommandsSizeIsQueriedThenCorrectSizeIsReturned) {
-    typedef typename FamilyType::MI_LOAD_REGISTER_IMM MI_LOAD_REGISTER_IMM;
+    using MI_LOAD_REGISTER_IMM = typename FamilyType::MI_LOAD_REGISTER_IMM;
+
     auto size = PreambleHelper<FamilyType>::getKernelDebuggingCommandsSize(true);
-    auto sizeExpected = 2 * sizeof(MI_LOAD_REGISTER_IMM);
-    EXPECT_EQ(sizeExpected, size);
+    auto expectedProgrammedCmdsCount = UnitTestHelper<FamilyType>::getMiLoadRegisterImmProgrammedCmdsCount(true);
+    auto expectedSize = expectedProgrammedCmdsCount * sizeof(MI_LOAD_REGISTER_IMM);
+    EXPECT_EQ(expectedSize, size);
 }
 
 HWTEST_F(PreambleTest, givenInactiveKernelDebuggingWhenPreambleKernelDebuggingCommandsSizeIsQueriedThenZeroIsReturned) {
@@ -121,7 +123,8 @@ HWTEST_F(PreambleTest, whenKernelDebuggingCommandsAreProgrammedThenCorrectComman
     hwParser.parseCommands<FamilyType>(stream);
     auto cmdList = hwParser.getCommandsList<MI_LOAD_REGISTER_IMM>();
 
-    ASSERT_EQ(2u, cmdList.size());
+    auto expectedProgrammedCmdsCount = UnitTestHelper<FamilyType>::getMiLoadRegisterImmProgrammedCmdsCount(true);
+    ASSERT_EQ(expectedProgrammedCmdsCount, cmdList.size());
 
     auto it = cmdList.begin();
 
@@ -165,8 +168,9 @@ HWTEST_F(PreambleTest, givenKernelDebuggingActiveWhenPreambleIsProgrammedThenPro
     cmdList = hwParser2.getCommandsList<MI_LOAD_REGISTER_IMM>();
 
     auto miLoadRegImmCountWithDebugging = cmdList.size();
+    auto expectedProgrammedCmdsCount = UnitTestHelper<FamilyType>::getMiLoadRegisterImmProgrammedCmdsCount(true);
     ASSERT_LT(miLoadRegImmCountWithoutDebugging, miLoadRegImmCountWithDebugging);
-    EXPECT_EQ(2u, miLoadRegImmCountWithDebugging - miLoadRegImmCountWithoutDebugging);
+    EXPECT_EQ(expectedProgrammedCmdsCount, miLoadRegImmCountWithDebugging - miLoadRegImmCountWithoutDebugging);
 }
 
 HWTEST_F(PreambleTest, givenKernelDebuggingActiveAndMidThreadPreemptionWhenGetAdditionalCommandsSizeIsCalledThen2MiLoadRegisterImmCmdsAreAdded) {
@@ -180,7 +184,8 @@ HWTEST_F(PreambleTest, givenKernelDebuggingActiveAndMidThreadPreemptionWhenGetAd
     EXPECT_LT(withoutDebugging, withDebugging);
 
     size_t diff = withDebugging - withoutDebugging;
-    size_t sizeExpected = 2 * sizeof(typename FamilyType::MI_LOAD_REGISTER_IMM);
+    auto expectedProgrammedCmdsCount = UnitTestHelper<FamilyType>::getMiLoadRegisterImmProgrammedCmdsCount(true);
+    size_t sizeExpected = expectedProgrammedCmdsCount * sizeof(typename FamilyType::MI_LOAD_REGISTER_IMM);
     EXPECT_EQ(sizeExpected, diff);
 }
 

shared/test/unit_test/preamble/preamble_tests.cpp

@@ -20,33 +20,6 @@ using PreambleTest = ::testing::Test;
 
 using namespace NEO;
 
-HWTEST2_F(PreambleTest, whenKernelDebuggingCommandsAreProgrammedThenCorrectCommandsArePlacedIntoStream, IsXeHpgCore) {
-    typedef typename FamilyType::MI_LOAD_REGISTER_IMM MI_LOAD_REGISTER_IMM;
-
-    auto bufferSize = PreambleHelper<FamilyType>::getKernelDebuggingCommandsSize(true);
-    auto buffer = std::unique_ptr<char[]>(new char[bufferSize]);
-
-    LinearStream stream(buffer.get(), bufferSize);
-    PreambleHelper<FamilyType>::programKernelDebugging(&stream);
-
-    HardwareParse hwParser;
-    hwParser.parseCommands<FamilyType>(stream);
-    auto cmdList = hwParser.getCommandsList<MI_LOAD_REGISTER_IMM>();
-
-    ASSERT_EQ(2u, cmdList.size());
-
-    auto it = cmdList.begin();
-
-    MI_LOAD_REGISTER_IMM *pCmd = reinterpret_cast<MI_LOAD_REGISTER_IMM *>(*it);
-    EXPECT_EQ(0x20d8u, pCmd->getRegisterOffset());
-    EXPECT_EQ((1u << 5) | (1u << 21), pCmd->getDataDword());
-    it++;
-
-    pCmd = reinterpret_cast<MI_LOAD_REGISTER_IMM *>(*it);
-    EXPECT_EQ(0xe400u, pCmd->getRegisterOffset());
-    EXPECT_EQ((1u << 7) | (1u << 4) | (1u << 2) | (1u << 0), pCmd->getDataDword());
-}
-
 HWTEST2_F(PreambleTest, givenDisableEUFusionWhenProgramVFEStateThenFusedEUDispatchIsSetCorrectly, IsXeHpgCore) {
     typedef typename FamilyType::CFE_STATE CFE_STATE;