Add new functionality to load SIP from file

Related-To: NEO-5718

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

Author: zzdanowicz

level_zero/CMakeLists.txt

@@ -234,7 +234,7 @@ if(BUILD_WITH_L0)
                  ${COMPUTE_RUNTIME_DIR}/opencl/source/dll/create_tbx_sockets.cpp
                  ${COMPUTE_RUNTIME_DIR}/opencl/source/dll/get_devices.cpp
                  ${COMPUTE_RUNTIME_DIR}/opencl/source/dll/source_level_debugger_dll.cpp
-                 ${COMPUTE_RUNTIME_DIR}/shared/source/helpers/built_ins_helper.cpp
+                 ${COMPUTE_RUNTIME_DIR}/shared/source/built_ins/sip_init.cpp
                  ${COMPUTE_RUNTIME_DIR}/shared/source/aub/aub_stream_interface.cpp
   )
 

level_zero/cmake/l0_tests.cmake

@@ -66,7 +66,7 @@ add_library(compute_runtime_mockable_extra
             EXCLUDE_FROM_ALL
             ${CMAKE_CURRENT_LIST_DIR}/l0_tests.cmake
             ${NEO_SHARED_TEST_DIRECTORY}/unit_test/utilities/cpuintrinsics.cpp
-            ${NEO_SHARED_TEST_DIRECTORY}/common/helpers/built_ins_helper.cpp
+            ${NEO_SHARED_TEST_DIRECTORY}/common/helpers/sip_init.cpp
             ${NEO_SHARED_TEST_DIRECTORY}/common/helpers/test_files.cpp
             ${NEO_SHARED_TEST_DIRECTORY}/common/mocks/mock_compiler_interface_spirv.cpp
             ${NEO_SHARED_TEST_DIRECTORY}/common/mocks/mock_compiler_interface_spirv.h

level_zero/core/source/cmdqueue/cmdqueue_hw.inl

@@ -286,7 +286,7 @@ ze_result_t CommandQueueHw<gfxCoreFamily>::executeCommandLists(
         }
 
         if (sipKernelUsed) {
-            auto sipIsa = NEO::SipKernel::getSipKernelAllocation(*neoDevice);
+            auto sipIsa = NEO::SipKernel::getSipKernel(*neoDevice).getSipAllocation();
             residencyContainer.push_back(sipIsa);
         }
 

level_zero/core/source/device/device_imp.cpp

@@ -14,7 +14,6 @@
 #include "shared/source/execution_environment/execution_environment.h"
 #include "shared/source/execution_environment/root_device_environment.h"
 #include "shared/source/gmm_helper/gmm_helper.h"
-#include "shared/source/helpers/built_ins_helper.h"
 #include "shared/source/helpers/constants.h"
 #include "shared/source/helpers/engine_node_helper.h"
 #include "shared/source/helpers/hw_helper.h"
@@ -646,10 +645,10 @@ Device *Device::create(DriverHandle *driverHandle, NEO::Device *neoDevice, uint3
     if (neoDevice->getCompilerInterface()) {
         auto hwInfo = neoDevice->getHardwareInfo();
         if (neoDevice->getPreemptionMode() == NEO::PreemptionMode::MidThread || neoDevice->getDebugger()) {
-            auto sipType = NEO::SipKernel::getSipKernelType(hwInfo.platform.eRenderCoreFamily, neoDevice->getDebugger());
-            NEO::initSipKernel(sipType, *neoDevice);
+            bool ret = NEO::SipKernel::initSipKernel(NEO::SipKernel::getSipKernelType(*neoDevice), *neoDevice);
+            UNRECOVERABLE_IF(!ret);
 
-            auto stateSaveAreaHeader = NEO::SipKernel::getSipStateSaveAreaHeader(*neoDevice);
+            auto &stateSaveAreaHeader = NEO::SipKernel::getSipKernel(*neoDevice).getStateSaveAreaHeader();
             if (debugSurface && stateSaveAreaHeader.size() > 0) {
                 auto &hwHelper = NEO::HwHelper::get(hwInfo.platform.eRenderCoreFamily);
                 NEO::MemoryTransferHelper::transferMemoryToAllocation(hwHelper.isBlitCopyRequiredForLocalMemory(hwInfo, *debugSurface),

level_zero/core/test/unit_tests/sources/cmdqueue/test_cmdqueue_enqueuecommandlist.cpp

@@ -306,7 +306,7 @@ HWTEST_F(CommandQueueExecuteCommandLists, givenMidThreadPreemptionWhenCommandsAr
         if (preemptionMode == NEO::PreemptionMode::MidThread) {
             EXPECT_NE(cmdList.end(), itorSip);
 
-            auto sipAllocation = SipKernel::getSipKernelAllocation(*neoDevice);
+            auto sipAllocation = SipKernel::getSipKernel(*neoDevice).getSipAllocation();
             STATE_SIP *stateSipCmd = reinterpret_cast<STATE_SIP *>(*itorSip);
             EXPECT_EQ(sipAllocation->getGpuAddressToPatch(), stateSipCmd->getSystemInstructionPointer());
         } else {
@@ -361,7 +361,7 @@ HWTEST2_F(CommandQueueExecuteCommandLists, givenMidThreadPreemptionWhenCommandsA
         if (preemptionMode == NEO::PreemptionMode::MidThread) {
             EXPECT_NE(cmdList.end(), itorSip);
 
-            auto sipAllocation = SipKernel::getSipKernelAllocation(*neoDevice);
+            auto sipAllocation = SipKernel::getSipKernel(*neoDevice).getSipAllocation();
             STATE_SIP *stateSipCmd = reinterpret_cast<STATE_SIP *>(*itorSip);
             EXPECT_EQ(sipAllocation->getGpuAddressToPatch(), stateSipCmd->getSystemInstructionPointer());
         } else {

level_zero/core/test/unit_tests/sources/debugger/test_l0_debugger.cpp

@@ -39,20 +39,21 @@ TEST_F(L0DebuggerTest, givenL0DebuggerWhenGettingL0DebuggerThenValidDebuggerInst
 }
 
 TEST_F(L0DebuggerTest, givenL0DebuggerWhenGettingSipAllocationThenValidSipTypeIsReturned) {
-    auto systemRoutine = SipKernel::getSipKernelAllocation(*neoDevice);
+    neoDevice->setDebuggerActive(true);
+    auto systemRoutine = SipKernel::getSipKernel(*neoDevice).getSipAllocation();
     ASSERT_NE(nullptr, systemRoutine);
 
-    auto sipType = SipKernel::getSipKernelType(neoDevice->getHardwareInfo().platform.eRenderCoreFamily, true);
+    auto sipType = SipKernel::getSipKernelType(*neoDevice);
     auto expectedSipAllocation = neoDevice->getBuiltIns()->getSipKernel(sipType, *neoDevice).getSipAllocation();
 
     EXPECT_EQ(expectedSipAllocation, systemRoutine);
 }
 
 TEST_F(L0DebuggerTest, givenL0DebuggerWhenGettingStateSaveAreaHeaderThenValidSipTypeIsReturned) {
-    auto stateSaveAreaHeader = SipKernel::getSipStateSaveAreaHeader(*neoDevice);
+    auto &stateSaveAreaHeader = SipKernel::getSipKernel(*neoDevice).getStateSaveAreaHeader();
 
-    auto sipType = SipKernel::getSipKernelType(neoDevice->getHardwareInfo().platform.eRenderCoreFamily, true);
-    auto expectedStateSaveAreaHeader = neoDevice->getBuiltIns()->getSipKernel(sipType, *neoDevice).getStateSaveAreaHeader();
+    auto sipType = SipKernel::getSipKernelType(*neoDevice);
+    auto &expectedStateSaveAreaHeader = neoDevice->getBuiltIns()->getSipKernel(sipType, *neoDevice).getStateSaveAreaHeader();
 
     EXPECT_EQ(expectedStateSaveAreaHeader, stateSaveAreaHeader);
 }
@@ -75,10 +76,10 @@ TEST(Debugger, givenL0DebuggerOFFWhenGettingStateSaveAreaHeaderThenValidSipTypeI
 
     driverHandle->initialize(std::move(devices));
 
-    auto stateSaveAreaHeader = SipKernel::getSipStateSaveAreaHeader(*neoDevice);
+    auto &stateSaveAreaHeader = SipKernel::getSipKernel(*neoDevice).getStateSaveAreaHeader();
 
-    auto sipType = SipKernel::getSipKernelType(neoDevice->getHardwareInfo().platform.eRenderCoreFamily, false);
-    auto expectedStateSaveAreaHeader = neoDevice->getBuiltIns()->getSipKernel(sipType, *neoDevice).getStateSaveAreaHeader();
+    auto sipType = SipKernel::getSipKernelType(*neoDevice);
+    auto &expectedStateSaveAreaHeader = neoDevice->getBuiltIns()->getSipKernel(sipType, *neoDevice).getStateSaveAreaHeader();
 
     EXPECT_EQ(expectedStateSaveAreaHeader, stateSaveAreaHeader);
 }
@@ -181,7 +182,7 @@ HWTEST_F(L0DebuggerTest, givenDebuggingEnabledWhenCommandListIsExecutedThenValid
 
         STATE_SIP *stateSip = genCmdCast<STATE_SIP *>(*stateSipCmds[0]);
 
-        auto systemRoutine = SipKernel::getSipKernelAllocation(*neoDevice);
+        auto systemRoutine = SipKernel::getSipKernel(*neoDevice).getSipAllocation();
         ASSERT_NE(nullptr, systemRoutine);
         EXPECT_EQ(systemRoutine->getGpuAddress(), stateSip->getSystemInstructionPointer());
     }
@@ -512,7 +513,7 @@ HWTEST2_F(L0DebuggerInternalUsageTest, givenDebuggingEnabledWhenInternalCmdQIsUs
     EXPECT_EQ(ZE_RESULT_SUCCESS, result);
 
     auto sbaBuffer = device->getL0Debugger()->getSbaTrackingBuffer(neoDevice->getDefaultEngine().commandStreamReceiver->getOsContext().getContextId());
-    auto sipIsa = NEO::SipKernel::getSipKernelAllocation(*neoDevice);
+    auto sipIsa = NEO::SipKernel::getSipKernel(*neoDevice).getSipAllocation();
     auto debugSurface = device->getDebugSurface();
     bool sbaFound = false;
     bool sipFound = false;

level_zero/core/test/unit_tests/sources/debugger/test_source_level_debugger.cpp

@@ -219,7 +219,7 @@ HWTEST2_F(SLDebuggerInternalUsageTest, givenDebuggingEnabledWhenInternalCmdQIsUs
         EXPECT_EQ(0u, stateSip.size());
     }
 
-    auto sipIsa = NEO::SipKernel::getSipKernelAllocation(*device);
+    auto sipIsa = NEO::SipKernel::getSipKernel(*device).getSipAllocation();
     auto debugSurface = deviceL0->getDebugSurface();
     bool sipFound = false;
     bool debugSurfaceFound = false;

level_zero/core/test/unit_tests/sources/device/test_device.cpp

@@ -11,6 +11,7 @@
 #include "shared/source/os_interface/os_time.h"
 #include "shared/test/common/helpers/debug_manager_state_restore.h"
 #include "shared/test/common/mocks/mock_device.h"
+#include "shared/test/common/mocks/mock_sip.h"
 #include "shared/test/common/mocks/ult_device_factory.h"
 
 #include "opencl/source/os_interface/os_inc_base.h"
@@ -31,13 +32,6 @@
 
 using ::testing::Return;
 
-namespace NEO {
-namespace MockSipData {
-extern SipKernelType calledType;
-extern bool called;
-} // namespace MockSipData
-} // namespace NEO
-
 namespace L0 {
 namespace ult {
 
@@ -66,6 +60,7 @@ TEST(L0DeviceTest, givenMidThreadPreemptionWhenCreatingDeviceThenSipKernelIsInit
     ze_result_t returnValue = ZE_RESULT_SUCCESS;
     VariableBackup<bool> mockSipCalled(&NEO::MockSipData::called, false);
     VariableBackup<NEO::SipKernelType> mockSipCalledType(&NEO::MockSipData::calledType, NEO::SipKernelType::COUNT);
+    VariableBackup<bool> backupSipInitType(&MockSipData::useMockSip, true);
 
     std::unique_ptr<DriverHandleImp> driverHandle(new DriverHandleImp);
     auto hwInfo = *NEO::defaultHwInfo;
@@ -103,14 +98,16 @@ TEST(L0DeviceTest, givenDebuggerEnabledButIGCNotReturnsSSAHThenSSAHIsNotCopied)
     driverHandle->enableProgramDebugging = true;
 
     driverHandle->initialize(std::move(devices));
-    auto stateSaveAreaHeader = NEO::SipKernel::getSipStateSaveAreaHeader(*neoDevice);
+    auto sipType = SipKernel::getSipKernelType(*neoDevice);
+    auto &stateSaveAreaHeader = neoDevice->getBuiltIns()->getSipKernel(sipType, *neoDevice).getStateSaveAreaHeader();
     EXPECT_EQ(static_cast<size_t>(0), stateSaveAreaHeader.size());
 }
 
 TEST(L0DeviceTest, givenDisabledPreemptionWhenCreatingDeviceThenSipKernelIsNotInitialized) {
     ze_result_t returnValue = ZE_RESULT_SUCCESS;
     VariableBackup<bool> mockSipCalled(&NEO::MockSipData::called, false);
     VariableBackup<NEO::SipKernelType> mockSipCalledType(&NEO::MockSipData::calledType, NEO::SipKernelType::COUNT);
+    VariableBackup<bool> backupSipInitType(&MockSipData::useMockSip, true);
 
     std::unique_ptr<DriverHandleImp> driverHandle(new DriverHandleImp);
     auto hwInfo = *NEO::defaultHwInfo;

opencl/source/built_ins/builtins_dispatch_builder.cpp

@@ -11,7 +11,6 @@
 #include "shared/source/built_ins/sip.h"
 #include "shared/source/compiler_interface/compiler_interface.h"
 #include "shared/source/helpers/basic_math.h"
-#include "shared/source/helpers/built_ins_helper.h"
 #include "shared/source/helpers/debug_helpers.h"
 
 #include "opencl/source/built_ins/aux_translation_builtin.h"

opencl/source/dll/CMakeLists.txt

@@ -18,12 +18,12 @@ set(RUNTIME_SRCS_DLL_BASE
     ${CMAKE_CURRENT_SOURCE_DIR}/debug_manager.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/source_level_debugger_dll.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}${BRANCH_DIR_SUFFIX}/get_devices.cpp
+    ${NEO_SHARED_DIRECTORY}/built_ins/sip_init.cpp
     ${NEO_SHARED_DIRECTORY}/dll/options_dll.cpp
     ${NEO_SHARED_DIRECTORY}/gmm_helper/resource_info.cpp
     ${NEO_SHARED_DIRECTORY}/gmm_helper/page_table_mngr.cpp
     ${NEO_SHARED_DIRECTORY}/helpers/abort.cpp
     ${NEO_SHARED_DIRECTORY}/helpers/allow_deferred_deleter.cpp
-    ${NEO_SHARED_DIRECTORY}/helpers/built_ins_helper.cpp
     ${NEO_SHARED_DIRECTORY}/helpers/debug_helpers.cpp
     ${NEO_SHARED_DIRECTORY}/utilities/cpuintrinsics.cpp
     ${NEO_SHARED_DIRECTORY}/utilities/debug_settings_reader_creator.cpp