Add Debug API handlers

Related-To: NEO-4554


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

Author: HoppeMateusz

level_zero/api/tools/zet_debug.cpp

@@ -5,21 +5,23 @@
  *
  */
 
+#include "level_zero/core/source/device/device.h"
+#include "level_zero/tools/source/debug/debug_handlers.h"
 #include <level_zero/zet_api.h>
 
 ZE_APIEXPORT ze_result_t ZE_APICALL
 zetDeviceGetDebugProperties(
     zet_device_handle_t hDevice,
     zet_device_debug_properties_t *pDebugProperties) {
-    return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
+    return L0::Device::fromHandle(hDevice)->getDebugProperties(pDebugProperties);
 }
 
 ZE_APIEXPORT ze_result_t ZE_APICALL
 zetDebugAttach(
     zet_device_handle_t hDevice,
     const zet_debug_config_t *config,
     zet_debug_session_handle_t *phDebug) {
-    return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
+    return L0::debugAttach(hDevice, config, phDebug);
 }
 
 ZE_APIEXPORT ze_result_t ZE_APICALL

level_zero/core/source/device/device.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2020 Intel Corporation
+ * Copyright (C) 2019-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -36,6 +36,7 @@ struct BuiltinFunctionsLib;
 struct ExecutionEnvironment;
 struct MetricContext;
 struct SysmanDevice;
+struct DebugSession;
 
 enum class ModuleType;
 
@@ -72,6 +73,8 @@ struct Device : _ze_device_handle_t {
 
     virtual ze_result_t getCommandQueueGroupProperties(uint32_t *pCount,
                                                        ze_command_queue_group_properties_t *pCommandQueueGroupProperties) = 0;
+    virtual ze_result_t getDebugProperties(zet_device_debug_properties_t *pDebugProperties) = 0;
+
     virtual ze_result_t systemBarrier() = 0;
 
     virtual ~Device() = default;
@@ -87,6 +90,7 @@ struct Device : _ze_device_handle_t {
     virtual NEO::OSInterface &getOsInterface() = 0;
     virtual uint32_t getPlatformInfo() const = 0;
     virtual MetricContext &getMetricContext() = 0;
+    virtual DebugSession *getDebugSession(const zet_debug_config_t &config) = 0;
 
     virtual ze_result_t activateMetricGroups(uint32_t count,
                                              zet_metric_group_handle_t *phMetricGroups) = 0;

level_zero/core/source/device/device_imp.cpp

@@ -40,6 +40,7 @@
 #include "level_zero/core/source/module/module.h"
 #include "level_zero/core/source/printf_handler/printf_handler.h"
 #include "level_zero/core/source/sampler/sampler.h"
+#include "level_zero/tools/source/debug/debug_session.h"
 #include "level_zero/tools/source/metrics/metric.h"
 #include "level_zero/tools/source/sysman/sysman.h"
 
@@ -486,6 +487,16 @@ ze_result_t DeviceImp::getDeviceImageProperties(ze_device_image_properties_t *pD
     return ZE_RESULT_SUCCESS;
 }
 
+ze_result_t DeviceImp::getDebugProperties(zet_device_debug_properties_t *pDebugProperties) {
+    bool isDebugAttachAvailable = getOsInterface().isDebugAttachAvailable();
+    if (isDebugAttachAvailable && !isSubdevice) {
+        pDebugProperties->flags = zet_device_debug_property_flag_t::ZET_DEVICE_DEBUG_PROPERTY_FLAG_ATTACH;
+    } else {
+        pDebugProperties->flags = 0;
+    }
+    return ZE_RESULT_SUCCESS;
+}
+
 ze_result_t DeviceImp::systemBarrier() { return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE; }
 
 ze_result_t DeviceImp::activateMetricGroups(uint32_t count,
@@ -799,4 +810,17 @@ ze_result_t DeviceImp::mapOrdinalForAvailableEngineGroup(uint32_t *ordinal) {
     *ordinal = i - 1;
     return ZE_RESULT_SUCCESS;
 };
+
+DebugSession *DeviceImp::getDebugSession(const zet_debug_config_t &config) {
+    if (debugSession != nullptr) {
+        return debugSession.get();
+    }
+
+    if (!this->isSubdevice) {
+        auto session = DebugSession::create(config, this);
+        debugSession.reset(session);
+    }
+    return debugSession.get();
+}
+
 } // namespace L0

level_zero/core/source/device/device_imp.h

@@ -12,10 +12,12 @@
 #include "level_zero/core/source/device/device.h"
 #include "level_zero/core/source/driver/driver_handle.h"
 #include "level_zero/core/source/module/module.h"
+#include "level_zero/tools/source/debug/debug_session.h"
 #include "level_zero/tools/source/metrics/metric.h"
 
 namespace L0 {
 struct SysmanDevice;
+
 struct DeviceImp : public Device {
     uint32_t getRootDeviceIndex() override;
     ze_result_t canAccessPeer(ze_device_handle_t hPeerDevice, ze_bool_t *value) override;
@@ -44,6 +46,8 @@ struct DeviceImp : public Device {
     ze_result_t getCommandQueueGroupProperties(uint32_t *pCount,
                                                ze_command_queue_group_properties_t *pCommandQueueGroupProperties) override;
     ze_result_t getExternalMemoryProperties(ze_device_external_memory_properties_t *pExternalMemoryProperties) override;
+    ze_result_t getDebugProperties(zet_device_debug_properties_t *pDebugProperties) override;
+
     ze_result_t systemBarrier() override;
     void *getExecEnvironment() override;
     BuiltinFunctionsLib *getBuiltinFunctionsLib() override;
@@ -54,6 +58,8 @@ struct DeviceImp : public Device {
     NEO::OSInterface &getOsInterface() override;
     uint32_t getPlatformInfo() const override;
     MetricContext &getMetricContext() override;
+    DebugSession *getDebugSession(const zet_debug_config_t &config) override;
+
     uint32_t getMaxNumHwThreads() const override;
     ze_result_t activateMetricGroups(uint32_t count,
                                      zet_metric_group_handle_t *phMetricGroups) override;
@@ -95,6 +101,7 @@ struct DeviceImp : public Device {
   protected:
     NEO::GraphicsAllocation *debugSurface = nullptr;
     SysmanDevice *pSysmanDevice = nullptr;
+    std::unique_ptr<DebugSession> debugSession = nullptr;
 };
 
 } // namespace L0

level_zero/core/test/unit_tests/mocks/mock_device.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2020 Intel Corporation
+ * Copyright (C) 2019-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -9,6 +9,8 @@
 
 #include "shared/source/device/device.h"
 
+#include "level_zero/tools/source/debug/debug_session.h"
+
 #include "gmock/gmock.h"
 
 namespace L0 {

level_zero/core/test/unit_tests/mocks/mock_device.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2020 Intel Corporation
+ * Copyright (C) 2019-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -242,11 +242,20 @@ struct Mock<Device> : public Device {
     ze_result_t mapOrdinalForAvailableEngineGroup(uint32_t *ordinal) override {
         return ZE_RESULT_SUCCESS;
     }
+
+    ze_result_t getDebugProperties(zet_device_debug_properties_t *properties) override {
+        return ZE_RESULT_SUCCESS;
+    }
+
+    DebugSession *getDebugSession(const zet_debug_config_t &config) override {
+        return nullptr;
+    }
 };
 
 template <>
 struct Mock<L0::DeviceImp> : public L0::DeviceImp {
     using Base = L0::DeviceImp;
+    using Base::debugSession;
 
     explicit Mock(NEO::Device *device, NEO::ExecutionEnvironment *execEnv) {
         device->incRefInternal();

level_zero/core/test/unit_tests/mocks/mock_device_for_spirv.cpp

@@ -13,6 +13,8 @@
 #include "opencl/test/unit_test/global_environment.h"
 #include "opencl/test/unit_test/helpers/kernel_binary_helper.h"
 
+#include "level_zero/tools/source/debug/debug_session.h"
+
 namespace L0 {
 namespace ult {
 template <bool useImagesBuiltins>

level_zero/tools/source/CMakeLists.txt

@@ -1,9 +1,10 @@
 #
-# Copyright (C) 2019-2020 Intel Corporation
+# Copyright (C) 2019-2021 Intel Corporation
 #
 # SPDX-License-Identifier: MIT
 #
 
+add_subdirectory(debug)
 add_subdirectory(metrics)
 add_subdirectory(sysman)
 add_subdirectory(pin)

level_zero/tools/source/debug/CMakeLists.txt

@@ -0,0 +1,19 @@
+#
+# Copyright (C) 2021 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
+#
+
+set(L0_SRCS_TOOLS_DEBUG
+    ${CMAKE_CURRENT_SOURCE_DIR}/debug_session.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/debug_handlers.h
+    ${CMAKE_CURRENT_SOURCE_DIR}${BRANCH_DIR_SUFFIX}/debug_handlers.cpp
+)
+
+add_subdirectories()
+
+target_sources(${L0_STATIC_LIB_NAME}
+               PRIVATE
+               ${L0_SRCS_TOOLS_DEBUG}
+               ${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt
+)

level_zero/tools/source/debug/debug_handlers.cpp

@@ -0,0 +1,20 @@
+/*
+ * Copyright (C) 2021 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+
+#include "level_zero/tools/source/debug/debug_session.h"
+
+namespace L0 {
+
+DebugSession *DebugSession::create(const zet_debug_config_t &config, Device *device) {
+    return nullptr;
+}
+
+ze_result_t debugAttach(zet_device_handle_t hDevice, const zet_debug_config_t *config, zet_debug_session_handle_t *phDebug) {
+    return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+} // namespace L0