compute-runtime/level_zero/tools/source/debug/debug_session.h

122 lines
5.0 KiB
C++

/*
* Copyright (C) 2021-2022 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#pragma once
#include "shared/source/debugger/debugger_l0.h"
#include "shared/source/os_interface/os_thread.h"
#include "level_zero/tools/source/debug/eu_thread.h"
#include <level_zero/ze_api.h>
#include <level_zero/zet_api.h>
#include <memory>
struct _zet_debug_session_handle_t {};
namespace L0 {
struct Device;
struct DebugSession : _zet_debug_session_handle_t {
virtual ~DebugSession() = default;
DebugSession() = delete;
static DebugSession *create(const zet_debug_config_t &config, Device *device, ze_result_t &result);
static DebugSession *fromHandle(zet_debug_session_handle_t handle) { return static_cast<DebugSession *>(handle); }
inline zet_debug_session_handle_t toHandle() { return this; }
virtual bool closeConnection() = 0;
virtual ze_result_t initialize() = 0;
virtual ze_result_t readEvent(uint64_t timeout, zet_debug_event_t *event) = 0;
virtual ze_result_t interrupt(ze_device_thread_t thread) = 0;
virtual ze_result_t resume(ze_device_thread_t thread) = 0;
virtual ze_result_t readMemory(ze_device_thread_t thread, const zet_debug_memory_space_desc_t *desc, size_t size, void *buffer) = 0;
virtual ze_result_t writeMemory(ze_device_thread_t thread, const zet_debug_memory_space_desc_t *desc, size_t size, const void *buffer) = 0;
virtual ze_result_t acknowledgeEvent(const zet_debug_event_t *event) = 0;
virtual ze_result_t readRegisters(ze_device_thread_t thread, uint32_t type, uint32_t start, uint32_t count, void *pRegisterValues) = 0;
virtual ze_result_t writeRegisters(ze_device_thread_t thread, uint32_t type, uint32_t start, uint32_t count, void *pRegisterValues) = 0;
static ze_result_t getRegisterSetProperties(Device *device, uint32_t *pCount, zet_debug_regset_properties_t *pRegisterSetProperties);
MOCKABLE_VIRTUAL bool areRequestedThreadsStopped(ze_device_thread_t thread);
Device *getConnectedDevice() { return connectedDevice; }
static bool isThreadAll(ze_device_thread_t thread) {
return thread.slice == UINT32_MAX && thread.subslice == UINT32_MAX && thread.eu == UINT32_MAX && thread.thread == UINT32_MAX;
}
static bool isSingleThread(ze_device_thread_t thread) {
return thread.slice != UINT32_MAX && thread.subslice != UINT32_MAX && thread.eu != UINT32_MAX && thread.thread != UINT32_MAX;
}
static bool areThreadsEqual(ze_device_thread_t thread, ze_device_thread_t thread2) {
return thread.slice == thread2.slice && thread.subslice == thread2.subslice && thread.eu == thread2.eu && thread.thread == thread2.thread;
}
static bool checkSingleThreadWithinDeviceThread(ze_device_thread_t checkedThread, ze_device_thread_t thread) {
if (DebugSession::isThreadAll(thread)) {
return true;
}
bool threadMatch = (thread.thread == checkedThread.thread) || thread.thread == UINT32_MAX;
bool euMatch = (thread.eu == checkedThread.eu) || thread.eu == UINT32_MAX;
bool subsliceMatch = (thread.subslice == checkedThread.subslice) || thread.subslice == UINT32_MAX;
bool sliceMatch = (thread.slice == checkedThread.slice) || thread.slice == UINT32_MAX;
return threadMatch && euMatch && subsliceMatch && sliceMatch;
}
static void printBitmask(uint8_t *bitmask, size_t bitmaskSize);
virtual uint32_t getDeviceIndexFromApiThread(ze_device_thread_t thread);
virtual ze_device_thread_t convertToPhysicalWithinDevice(ze_device_thread_t thread, uint32_t deviceIndex);
virtual EuThread::ThreadId convertToThreadId(ze_device_thread_t thread);
virtual ze_device_thread_t convertToApi(EuThread::ThreadId threadId);
ze_result_t sanityMemAccessThreadCheck(ze_device_thread_t thread, const zet_debug_memory_space_desc_t *desc);
struct ThreadHelper {
void close() {
threadActive.store(false);
if (thread) {
while (!threadFinished.load()) {
thread->yield();
}
thread->join();
thread.reset();
}
}
std::unique_ptr<NEO::Thread> thread;
std::atomic<bool> threadActive{true};
std::atomic<bool> threadFinished{false};
};
protected:
DebugSession(const zet_debug_config_t &config, Device *device);
virtual void startAsyncThread() = 0;
virtual bool isBindlessSystemRoutine();
virtual bool readModuleDebugArea() = 0;
virtual ze_result_t readSbaBuffer(EuThread::ThreadId threadId, NEO::SbaTrackedAddresses &sbaBuffer) = 0;
void fillDevicesFromThread(ze_device_thread_t thread, std::vector<uint8_t> &devices);
std::vector<EuThread::ThreadId> getSingleThreadsForDevice(uint32_t deviceIndex, ze_device_thread_t physicalThread, const NEO::HardwareInfo &hwInfo);
size_t getPerThreadScratchOffset(size_t ptss, EuThread::ThreadId threadId);
NEO::DebugAreaHeader debugArea;
Device *connectedDevice = nullptr;
std::map<uint64_t, std::unique_ptr<EuThread>> allThreads;
};
} // namespace L0