Refactor: move DebuggerL0 initialization to RootDeviceEnvironment

Signed-off-by: Mateusz Hoppe <[email protected]>

Author: HoppeMateusz

level_zero/core/source/driver/driver_handle_imp.cpp

@@ -168,20 +168,10 @@ void DriverHandleImp::updateRootDeviceBitFields(std::unique_ptr<NEO::Device> &ne
 }
 
 void DriverHandleImp::enableRootDeviceDebugger(std::unique_ptr<NEO::Device> &neoDevice) {
-    const auto rootDeviceIndex = neoDevice->getRootDeviceIndex();
-    auto rootDeviceEnvironment = neoDevice->getExecutionEnvironment()->rootDeviceEnvironments[rootDeviceIndex].get();
-
     if (enableProgramDebugging) {
-        if (neoDevice->getDebugger() != nullptr) {
-            NEO::printDebugString(NEO::DebugManager.flags.PrintDebugMessages.get(), stderr,
-                                  "%s", "Source Level Debugger cannot be used with Environment Variable enabling program debugging.\n");
-            UNRECOVERABLE_IF(neoDevice->getDebugger() != nullptr && enableProgramDebugging);
-        }
-        rootDeviceEnvironment->getMutableHardwareInfo()->capabilityTable.fusedEuEnabled = false;
-        rootDeviceEnvironment->getMutableHardwareInfo()->capabilityTable.ftrRenderCompressedBuffers = false;
-        rootDeviceEnvironment->getMutableHardwareInfo()->capabilityTable.ftrRenderCompressedImages = false;
-
-        rootDeviceEnvironment->debugger = NEO::DebuggerL0::create(neoDevice.get());
+        const auto rootDeviceIndex = neoDevice->getRootDeviceIndex();
+        auto rootDeviceEnvironment = neoDevice->getExecutionEnvironment()->rootDeviceEnvironments[rootDeviceIndex].get();
+        rootDeviceEnvironment->initDebuggerL0(neoDevice.get());
     }
 }
 

opencl/source/dll/CMakeLists.txt

@@ -46,6 +46,7 @@ append_sources_from_properties(RUNTIME_SRCS_DLL_BASE
 )
 
 set(RUNTIME_SRCS_DLL_LINUX
+    ${NEO_SHARED_DIRECTORY}/dll/linux/debugger_l0_dll_linux.cpp
     ${NEO_SHARED_DIRECTORY}/dll/linux/drm_neo_create.cpp
     ${NEO_SHARED_DIRECTORY}/dll/linux/options_linux.cpp
     ${NEO_SHARED_DIRECTORY}/dll/linux/os_interface.cpp
@@ -57,6 +58,7 @@ set(RUNTIME_SRCS_DLL_LINUX
 )
 
 set(RUNTIME_SRCS_DLL_WINDOWS
+    ${NEO_SHARED_DIRECTORY}/dll/windows/debugger_l0_windows.cpp
     ${NEO_SHARED_DIRECTORY}/dll/windows/options_windows.cpp
     ${NEO_SHARED_DIRECTORY}/dll/windows/os_interface.cpp
     ${NEO_SHARED_DIRECTORY}/dll/windows/environment_variables.cpp

shared/source/execution_environment/root_device_environment.cpp

@@ -13,6 +13,7 @@
 #include "shared/source/compiler_interface/compiler_interface.h"
 #include "shared/source/compiler_interface/default_cache_config.h"
 #include "shared/source/debugger/debugger.h"
+#include "shared/source/debugger/debugger_l0.h"
 #include "shared/source/execution_environment/execution_environment.h"
 #include "shared/source/gmm_helper/gmm_helper.h"
 #include "shared/source/gmm_helper/page_table_mngr.h"
@@ -46,6 +47,20 @@ void RootDeviceEnvironment::initDebugger() {
     debugger = Debugger::create(hwInfo.get());
 }
 
+void RootDeviceEnvironment::initDebuggerL0(Device *neoDevice) {
+    if (this->debugger.get() != nullptr) {
+        NEO::printDebugString(NEO::DebugManager.flags.PrintDebugMessages.get(), stderr,
+                              "%s", "Source Level Debugger cannot be used with Environment Variable enabling program debugging.\n");
+        UNRECOVERABLE_IF(this->debugger.get() != nullptr);
+    }
+
+    this->getMutableHardwareInfo()->capabilityTable.fusedEuEnabled = false;
+    this->getMutableHardwareInfo()->capabilityTable.ftrRenderCompressedBuffers = false;
+    this->getMutableHardwareInfo()->capabilityTable.ftrRenderCompressedImages = false;
+
+    this->debugger = DebuggerL0::create(neoDevice);
+}
+
 const HardwareInfo *RootDeviceEnvironment::getHardwareInfo() const {
     return hwInfo.get();
 }

shared/source/execution_environment/root_device_environment.h

@@ -22,6 +22,7 @@ class BindlessHeapsHelper;
 class BuiltIns;
 class CompilerInterface;
 class Debugger;
+class Device;
 class ExecutionEnvironment;
 class GmmClientContext;
 class GmmHelper;
@@ -54,6 +55,7 @@ struct RootDeviceEnvironment {
     void initOsTime();
     void initGmm();
     void initDebugger();
+    void initDebuggerL0(Device *neoDevice);
     MOCKABLE_VIRTUAL void prepareForCleanup() const;
     MOCKABLE_VIRTUAL bool initAilConfiguration();
     GmmHelper *getGmmHelper() const;

shared/test/unit_test/debugger/test_l0_debugger.cpp

@@ -120,6 +120,59 @@ TEST(Debugger, givenDebuggingEnabledInExecEnvWhenAllocatingIsaThenSingleBankIsUs
     neoDevice->getMemoryManager()->freeGraphicsMemory(allocation);
 }
 
+TEST(Debugger, WhenInitializingDebuggerL0ThenCapabilitiesAreAdjustedAndDebuggerIsCreated) {
+    auto executionEnvironment = new NEO::ExecutionEnvironment();
+    executionEnvironment->incRefInternal();
+    executionEnvironment->prepareRootDeviceEnvironments(1);
+
+    auto hwInfo = *NEO::defaultHwInfo.get();
+    executionEnvironment->rootDeviceEnvironments[0]->setHwInfo(&hwInfo);
+    executionEnvironment->rootDeviceEnvironments[0]->initGmm();
+    executionEnvironment->initializeMemoryManager();
+
+    executionEnvironment->setDebuggingEnabled();
+
+    auto neoDevice = std::unique_ptr<MockDevice>(MockDevice::create<MockDevice>(executionEnvironment, 0u));
+
+    executionEnvironment->rootDeviceEnvironments[0]->initDebuggerL0(neoDevice.get());
+
+    EXPECT_FALSE(executionEnvironment->rootDeviceEnvironments[0]->getMutableHardwareInfo()->capabilityTable.fusedEuEnabled);
+    EXPECT_FALSE(executionEnvironment->rootDeviceEnvironments[0]->getMutableHardwareInfo()->capabilityTable.ftrRenderCompressedBuffers);
+    EXPECT_FALSE(executionEnvironment->rootDeviceEnvironments[0]->getMutableHardwareInfo()->capabilityTable.ftrRenderCompressedImages);
+
+    EXPECT_NE(nullptr, executionEnvironment->rootDeviceEnvironments[0]->debugger);
+    executionEnvironment->decRefInternal();
+}
+
+TEST(Debugger, GivenLegacyDebuggerWhenInitializingDebuggerL0ThenAbortIsCalledAfterPrintingError) {
+    DebugManagerStateRestore restorer;
+    NEO::DebugManager.flags.PrintDebugMessages.set(1);
+
+    ::testing::internal::CaptureStderr();
+    auto executionEnvironment = new NEO::ExecutionEnvironment();
+    executionEnvironment->incRefInternal();
+    executionEnvironment->prepareRootDeviceEnvironments(1);
+
+    auto mockDebugger = new MockSourceLevelDebugger();
+    executionEnvironment->rootDeviceEnvironments[0]->debugger.reset(mockDebugger);
+
+    auto hwInfo = *NEO::defaultHwInfo.get();
+    executionEnvironment->rootDeviceEnvironments[0]->setHwInfo(&hwInfo);
+    executionEnvironment->rootDeviceEnvironments[0]->initGmm();
+    executionEnvironment->initializeMemoryManager();
+
+    executionEnvironment->setDebuggingEnabled();
+
+    auto neoDevice = std::unique_ptr<MockDevice>(MockDevice::create<MockDevice>(executionEnvironment, 0u));
+
+    EXPECT_THROW(executionEnvironment->rootDeviceEnvironments[0]->initDebuggerL0(neoDevice.get()), std::exception);
+    std::string output = testing::internal::GetCapturedStderr();
+
+    EXPECT_EQ(std::string("Source Level Debugger cannot be used with Environment Variable enabling program debugging.\n"), output);
+
+    executionEnvironment->decRefInternal();
+}
+
 using L0DebuggerTest = Test<DeviceFixture>;
 
 HWTEST_F(L0DebuggerTest, GivenDeviceWhenAllocateCalledThenDebuggerIsCreated) {