// Copyright 2016 Citra Emulator Project // Licensed under GPLv2 or any later version // Refer to the license.txt file included. #include #include #include "yuzu/debugger/wait_tree.h" #include "yuzu/uisettings.h" #include "yuzu/util/util.h" #include "common/assert.h" #include "core/arm/arm_interface.h" #include "core/core.h" #include "core/hle/kernel/handle_table.h" #include "core/hle/kernel/k_scheduler.h" #include "core/hle/kernel/k_synchronization_object.h" #include "core/hle/kernel/k_thread.h" #include "core/hle/kernel/process.h" #include "core/hle/kernel/readable_event.h" #include "core/hle/kernel/svc_common.h" #include "core/hle/kernel/svc_types.h" #include "core/memory.h" namespace { constexpr std::array, 10> WaitTreeColors{{ {Qt::GlobalColor::darkGreen, Qt::GlobalColor::green}, {Qt::GlobalColor::darkBlue, Qt::GlobalColor::cyan}, {Qt::GlobalColor::lightGray, Qt::GlobalColor::lightGray}, {Qt::GlobalColor::lightGray, Qt::GlobalColor::lightGray}, {Qt::GlobalColor::darkRed, Qt::GlobalColor::red}, {Qt::GlobalColor::darkYellow, Qt::GlobalColor::yellow}, {Qt::GlobalColor::red, Qt::GlobalColor::red}, {Qt::GlobalColor::darkCyan, Qt::GlobalColor::cyan}, {Qt::GlobalColor::gray, Qt::GlobalColor::gray}, }}; bool IsDarkTheme() { const auto& theme = UISettings::values.theme; return theme == QStringLiteral("qdarkstyle") || theme == QStringLiteral("qdarkstyle_midnight_blue") || theme == QStringLiteral("colorful_dark") || theme == QStringLiteral("colorful_midnight_blue"); } } // namespace WaitTreeItem::WaitTreeItem() = default; WaitTreeItem::~WaitTreeItem() = default; QColor WaitTreeItem::GetColor() const { if (IsDarkTheme()) { return QColor(Qt::GlobalColor::white); } else { return QColor(Qt::GlobalColor::black); } } std::vector> WaitTreeItem::GetChildren() const { return {}; } void WaitTreeItem::Expand() { if (IsExpandable() && !expanded) { children = GetChildren(); for (std::size_t i = 0; i < children.size(); ++i) { children[i]->parent = this; children[i]->row = i; } expanded = true; } } WaitTreeItem* WaitTreeItem::Parent() const { return parent; } const std::vector>& WaitTreeItem::Children() const { return children; } bool WaitTreeItem::IsExpandable() const { return false; } std::size_t WaitTreeItem::Row() const { return row; } std::vector> WaitTreeItem::MakeThreadItemList() { std::vector> item_list; std::size_t row = 0; auto add_threads = [&](const std::vector>& threads) { for (std::size_t i = 0; i < threads.size(); ++i) { if (threads[i]->GetThreadTypeForDebugging() == Kernel::ThreadType::User) { item_list.push_back(std::make_unique(*threads[i])); item_list.back()->row = row; } ++row; } }; const auto& system = Core::System::GetInstance(); add_threads(system.GlobalSchedulerContext().GetThreadList()); return item_list; } WaitTreeText::WaitTreeText(QString t) : text(std::move(t)) {} WaitTreeText::~WaitTreeText() = default; QString WaitTreeText::GetText() const { return text; } WaitTreeMutexInfo::WaitTreeMutexInfo(VAddr mutex_address, const Kernel::HandleTable& handle_table) : mutex_address(mutex_address) { mutex_value = Core::System::GetInstance().Memory().Read32(mutex_address); owner_handle = static_cast(mutex_value & Kernel::Svc::HandleWaitMask); owner = handle_table.Get(owner_handle); } WaitTreeMutexInfo::~WaitTreeMutexInfo() = default; QString WaitTreeMutexInfo::GetText() const { return tr("waiting for mutex 0x%1").arg(mutex_address, 16, 16, QLatin1Char{'0'}); } std::vector> WaitTreeMutexInfo::GetChildren() const { const bool has_waiters = (mutex_value & Kernel::Svc::HandleWaitMask) != 0; std::vector> list; list.push_back(std::make_unique(tr("has waiters: %1").arg(has_waiters))); list.push_back(std::make_unique( tr("owner handle: 0x%1").arg(owner_handle, 8, 16, QLatin1Char{'0'}))); if (owner != nullptr) { list.push_back(std::make_unique(*owner)); } return list; } WaitTreeCallstack::WaitTreeCallstack(const Kernel::KThread& thread) : thread(thread) {} WaitTreeCallstack::~WaitTreeCallstack() = default; QString WaitTreeCallstack::GetText() const { return tr("Call stack"); } std::vector> WaitTreeCallstack::GetChildren() const { std::vector> list; if (thread.GetThreadTypeForDebugging() != Kernel::ThreadType::User) { return list; } if (thread.GetOwnerProcess() == nullptr || !thread.GetOwnerProcess()->Is64BitProcess()) { return list; } auto backtrace = Core::ARM_Interface::GetBacktraceFromContext(Core::System::GetInstance(), thread.GetContext64()); for (auto& entry : backtrace) { std::string s = fmt::format("{:20}{:016X} {:016X} {:016X} {}", entry.module, entry.address, entry.original_address, entry.offset, entry.name); list.push_back(std::make_unique(QString::fromStdString(s))); } return list; } WaitTreeSynchronizationObject::WaitTreeSynchronizationObject( const Kernel::KSynchronizationObject& o) : object(o) {} WaitTreeSynchronizationObject::~WaitTreeSynchronizationObject() = default; WaitTreeExpandableItem::WaitTreeExpandableItem() = default; WaitTreeExpandableItem::~WaitTreeExpandableItem() = default; bool WaitTreeExpandableItem::IsExpandable() const { return true; } QString WaitTreeSynchronizationObject::GetText() const { return tr("[%1]%2 %3") .arg(object.GetObjectId()) .arg(QString::fromStdString(object.GetTypeName()), QString::fromStdString(object.GetName())); } std::unique_ptr WaitTreeSynchronizationObject::make( const Kernel::KSynchronizationObject& object) { switch (object.GetHandleType()) { case Kernel::HandleType::ReadableEvent: return std::make_unique(static_cast(object)); case Kernel::HandleType::Thread: return std::make_unique(static_cast(object)); default: return std::make_unique(object); } } std::vector> WaitTreeSynchronizationObject::GetChildren() const { std::vector> list; const auto& threads = object.GetWaitingThreadsForDebugging(); if (threads.empty()) { list.push_back(std::make_unique(tr("waited by no thread"))); } else { list.push_back(std::make_unique(threads)); } return list; } WaitTreeObjectList::WaitTreeObjectList(const std::vector& list, bool w_all) : object_list(list), wait_all(w_all) {} WaitTreeObjectList::~WaitTreeObjectList() = default; QString WaitTreeObjectList::GetText() const { if (wait_all) return tr("waiting for all objects"); return tr("waiting for one of the following objects"); } std::vector> WaitTreeObjectList::GetChildren() const { std::vector> list(object_list.size()); std::transform(object_list.begin(), object_list.end(), list.begin(), [](const auto& t) { return WaitTreeSynchronizationObject::make(*t); }); return list; } WaitTreeThread::WaitTreeThread(const Kernel::KThread& thread) : WaitTreeSynchronizationObject(thread) {} WaitTreeThread::~WaitTreeThread() = default; QString WaitTreeThread::GetText() const { const auto& thread = static_cast(object); QString status; switch (thread.GetState()) { case Kernel::ThreadState::Runnable: if (!thread.IsSuspended()) { status = tr("runnable"); } else { status = tr("paused"); } break; case Kernel::ThreadState::Waiting: switch (thread.GetWaitReasonForDebugging()) { case Kernel::ThreadWaitReasonForDebugging::Sleep: status = tr("sleeping"); break; case Kernel::ThreadWaitReasonForDebugging::IPC: status = tr("waiting for IPC reply"); break; case Kernel::ThreadWaitReasonForDebugging::Synchronization: status = tr("waiting for objects"); break; case Kernel::ThreadWaitReasonForDebugging::ConditionVar: status = tr("waiting for condition variable"); break; case Kernel::ThreadWaitReasonForDebugging::Arbitration: status = tr("waiting for address arbiter"); break; case Kernel::ThreadWaitReasonForDebugging::Suspended: status = tr("waiting for suspend resume"); break; default: status = tr("waiting"); break; } break; case Kernel::ThreadState::Initialized: status = tr("initialized"); break; case Kernel::ThreadState::Terminated: status = tr("terminated"); break; default: status = tr("unknown"); break; } const auto& context = thread.GetContext64(); const QString pc_info = tr(" PC = 0x%1 LR = 0x%2") .arg(context.pc, 8, 16, QLatin1Char{'0'}) .arg(context.cpu_registers[30], 8, 16, QLatin1Char{'0'}); return QStringLiteral("%1%2 (%3) ") .arg(WaitTreeSynchronizationObject::GetText(), pc_info, status); } QColor WaitTreeThread::GetColor() const { const std::size_t color_index = IsDarkTheme() ? 1 : 0; const auto& thread = static_cast(object); switch (thread.GetState()) { case Kernel::ThreadState::Runnable: if (!thread.IsSuspended()) { return QColor(WaitTreeColors[0][color_index]); } else { return QColor(WaitTreeColors[2][color_index]); } case Kernel::ThreadState::Waiting: switch (thread.GetWaitReasonForDebugging()) { case Kernel::ThreadWaitReasonForDebugging::IPC: return QColor(WaitTreeColors[4][color_index]); case Kernel::ThreadWaitReasonForDebugging::Sleep: return QColor(WaitTreeColors[5][color_index]); case Kernel::ThreadWaitReasonForDebugging::Synchronization: case Kernel::ThreadWaitReasonForDebugging::ConditionVar: case Kernel::ThreadWaitReasonForDebugging::Arbitration: case Kernel::ThreadWaitReasonForDebugging::Suspended: return QColor(WaitTreeColors[6][color_index]); break; default: return QColor(WaitTreeColors[3][color_index]); } case Kernel::ThreadState::Initialized: return QColor(WaitTreeColors[7][color_index]); case Kernel::ThreadState::Terminated: return QColor(WaitTreeColors[8][color_index]); default: return WaitTreeItem::GetColor(); } } std::vector> WaitTreeThread::GetChildren() const { std::vector> list(WaitTreeSynchronizationObject::GetChildren()); const auto& thread = static_cast(object); QString processor; switch (thread.GetActiveCore()) { case Kernel::Svc::IdealCoreUseProcessValue: processor = tr("ideal"); break; default: processor = tr("core %1").arg(thread.GetActiveCore()); break; } list.push_back(std::make_unique(tr("processor = %1").arg(processor))); list.push_back(std::make_unique( tr("ideal core = %1").arg(thread.GetIdealCoreForDebugging()))); list.push_back(std::make_unique( tr("affinity mask = %1").arg(thread.GetAffinityMask().GetAffinityMask()))); list.push_back(std::make_unique(tr("thread id = %1").arg(thread.GetThreadID()))); list.push_back(std::make_unique(tr("priority = %1(current) / %2(normal)") .arg(thread.GetPriority()) .arg(thread.GetBasePriority()))); list.push_back(std::make_unique( tr("last running ticks = %1").arg(thread.GetLastScheduledTick()))); const VAddr mutex_wait_address = thread.GetMutexWaitAddressForDebugging(); if (mutex_wait_address != 0) { const auto& handle_table = thread.GetOwnerProcess()->GetHandleTable(); list.push_back(std::make_unique(mutex_wait_address, handle_table)); } else { list.push_back(std::make_unique(tr("not waiting for mutex"))); } if (thread.GetState() == Kernel::ThreadState::Waiting && thread.GetWaitReasonForDebugging() == Kernel::ThreadWaitReasonForDebugging::Synchronization) { list.push_back(std::make_unique(thread.GetWaitObjectsForDebugging(), thread.IsCancellable())); } list.push_back(std::make_unique(thread)); return list; } WaitTreeEvent::WaitTreeEvent(const Kernel::ReadableEvent& object) : WaitTreeSynchronizationObject(object) {} WaitTreeEvent::~WaitTreeEvent() = default; WaitTreeThreadList::WaitTreeThreadList(const std::vector& list) : thread_list(list) {} WaitTreeThreadList::~WaitTreeThreadList() = default; QString WaitTreeThreadList::GetText() const { return tr("waited by thread"); } std::vector> WaitTreeThreadList::GetChildren() const { std::vector> list(thread_list.size()); std::transform(thread_list.begin(), thread_list.end(), list.begin(), [](const auto& t) { return std::make_unique(*t); }); return list; } WaitTreeModel::WaitTreeModel(QObject* parent) : QAbstractItemModel(parent) {} WaitTreeModel::~WaitTreeModel() = default; QModelIndex WaitTreeModel::index(int row, int column, const QModelIndex& parent) const { if (!hasIndex(row, column, parent)) return {}; if (parent.isValid()) { WaitTreeItem* parent_item = static_cast(parent.internalPointer()); parent_item->Expand(); return createIndex(row, column, parent_item->Children()[row].get()); } return createIndex(row, column, thread_items[row].get()); } QModelIndex WaitTreeModel::parent(const QModelIndex& index) const { if (!index.isValid()) return {}; WaitTreeItem* parent_item = static_cast(index.internalPointer())->Parent(); if (!parent_item) { return QModelIndex(); } return createIndex(static_cast(parent_item->Row()), 0, parent_item); } int WaitTreeModel::rowCount(const QModelIndex& parent) const { if (!parent.isValid()) return static_cast(thread_items.size()); WaitTreeItem* parent_item = static_cast(parent.internalPointer()); parent_item->Expand(); return static_cast(parent_item->Children().size()); } int WaitTreeModel::columnCount(const QModelIndex&) const { return 1; } QVariant WaitTreeModel::data(const QModelIndex& index, int role) const { if (!index.isValid()) return {}; switch (role) { case Qt::DisplayRole: return static_cast(index.internalPointer())->GetText(); case Qt::ForegroundRole: return static_cast(index.internalPointer())->GetColor(); default: return {}; } } void WaitTreeModel::ClearItems() { thread_items.clear(); } void WaitTreeModel::InitItems() { thread_items = WaitTreeItem::MakeThreadItemList(); } WaitTreeWidget::WaitTreeWidget(QWidget* parent) : QDockWidget(tr("&Wait Tree"), parent) { setObjectName(QStringLiteral("WaitTreeWidget")); view = new QTreeView(this); view->setHeaderHidden(true); setWidget(view); setEnabled(false); } WaitTreeWidget::~WaitTreeWidget() = default; void WaitTreeWidget::OnDebugModeEntered() { if (!Core::System::GetInstance().IsPoweredOn()) return; model->InitItems(); view->setModel(model); setEnabled(true); } void WaitTreeWidget::OnDebugModeLeft() { setEnabled(false); view->setModel(nullptr); model->ClearItems(); } void WaitTreeWidget::OnEmulationStarting(EmuThread* emu_thread) { model = new WaitTreeModel(this); view->setModel(model); setEnabled(false); } void WaitTreeWidget::OnEmulationStopping() { view->setModel(nullptr); delete model; setEnabled(false); }