rpcsx/rpcs3qt-legacy/breakpoint_list.cpp

#include "breakpoint_list.h"
#include "breakpoint_handler.h"

#include "Emu/CPU/CPUDisAsm.h"
#include "Emu/Cell/PPUThread.h"
#include "Emu/Cell/SPUThread.h"
#include "debugger_add_bp_window.h"

#include <QMenu>
#include <QMessageBox>
#include <QMouseEvent>

extern bool is_using_interpreter(thread_class t_class);

breakpoint_list::breakpoint_list(QWidget* parent, breakpoint_handler* handler) : QListWidget(parent), m_ppu_breakpoint_handler(handler)
{
	setEditTriggers(QAbstractItemView::NoEditTriggers);
	setContextMenuPolicy(Qt::CustomContextMenu);
	setSelectionMode(QAbstractItemView::ExtendedSelection);

	connect(this, &QListWidget::itemDoubleClicked, this, &breakpoint_list::OnBreakpointListDoubleClicked);
	connect(this, &QListWidget::customContextMenuRequested, this, &breakpoint_list::OnBreakpointListRightClicked);

	m_delete_action = new QAction(tr("&Delete"), this);
	m_delete_action->setShortcut(Qt::Key_Delete);
	m_delete_action->setShortcutContext(Qt::WidgetShortcut);
	connect(m_delete_action, &QAction::triggered, this, &breakpoint_list::OnBreakpointListDelete);
	addAction(m_delete_action);

	// Hide until used in order to allow as much space for registers panel as possible
	hide();
}

/**
 * It's unfortunate I need a method like this to sync these.  Should ponder a cleaner way to do this.
 */
void breakpoint_list::UpdateCPUData(std::shared_ptr<CPUDisAsm> disasm)
{
	m_disasm = std::move(disasm);
}

void breakpoint_list::ClearBreakpoints()
{
	while (count())
	{
		auto* currentItem = takeItem(0);
		const u32 loc = currentItem->data(Qt::UserRole).value<u32>();
		m_ppu_breakpoint_handler->RemoveBreakpoint(loc);
		delete currentItem;
	}

	hide();
}

void breakpoint_list::RemoveBreakpoint(u32 addr)
{
	m_ppu_breakpoint_handler->RemoveBreakpoint(addr);

	for (int i = 0; i < count(); i++)
	{
		QListWidgetItem* currentItem = item(i);

		if (currentItem->data(Qt::UserRole).value<u32>() == addr)
		{
			delete takeItem(i);
			break;
		}
	}

	if (!count())
	{
		hide();
	}
}

bool breakpoint_list::AddBreakpoint(u32 pc, bs_t<breakpoint_types> type)
{
	if (!m_ppu_breakpoint_handler->AddBreakpoint(pc, type))
	{
		return false;
	}

	QString breakpoint_item_text;

	if (type == breakpoint_types::bp_exec)
	{
		m_disasm->disasm(m_disasm->dump_pc = pc);
		breakpoint_item_text = QString::fromStdString(m_disasm->last_opcode);
		breakpoint_item_text.remove(10, 13);
	}
	else if (type == breakpoint_types::bp_read)
	{
		breakpoint_item_text = QString("BPMR:  0x%1").arg(pc, 8, 16, QChar('0'));
	}
	else if (type == breakpoint_types::bp_write)
	{
		breakpoint_item_text = QString("BPMW:  0x%1").arg(pc, 8, 16, QChar('0'));
	}
	else if (type == (breakpoint_types::bp_read + breakpoint_types::bp_write))
	{
		breakpoint_item_text = QString("BPMRW: 0x%1").arg(pc, 8, 16, QChar('0'));
	}

	QListWidgetItem* breakpoint_item = new QListWidgetItem(breakpoint_item_text);
	breakpoint_item->setForeground(m_text_color_bp);
	breakpoint_item->setBackground(m_color_bp);
	breakpoint_item->setData(Qt::UserRole, pc);
	addItem(breakpoint_item);

	show();

	return true;
}

/**
 * If breakpoint exists, we remove it, else add new one.  Yeah, it'd be nicer from a code logic to have it be set/reset.  But, that logic has to happen somewhere anyhow.
 */
void breakpoint_list::HandleBreakpointRequest(u32 loc, bool only_add)
{
	const auto cpu = m_disasm ? m_disasm->get_cpu() : nullptr;

	if (!cpu || cpu->state & cpu_flag::exit)
	{
		return;
	}

	if (!is_using_interpreter(cpu->get_class()))
	{
		QMessageBox::warning(this, tr("Interpreters-Only Feature!"), tr("Cannot set breakpoints on non-interpreter decoders."));
		return;
	}

	switch (cpu->get_class())
	{
	case thread_class::spu:
	{
		if (loc >= SPU_LS_SIZE || loc % 4)
		{
			QMessageBox::warning(this, tr("Invalid Memory For Breakpoints!"), tr("Cannot set breakpoints on non-SPU executable memory!"));
			return;
		}

		const auto spu = static_cast<spu_thread*>(cpu);
		auto& list = spu->local_breakpoints;
		const u32 pos_at = loc / 4;
		const u32 pos_bit = 1u << (pos_at % 8);

		if (list[pos_at / 8].fetch_xor(pos_bit) & pos_bit)
		{
			if (std::none_of(list.begin(), list.end(), [](auto& val)
					{
						return val.load();
					}))
			{
				spu->has_active_local_bps = false;
			}
		}
		else
		{
			if (!spu->has_active_local_bps.exchange(true))
			{
				spu->state.atomic_op([](bs_t<cpu_flag>& flags)
					{
						if (flags & cpu_flag::pending)
						{
							flags += cpu_flag::pending_recheck;
						}
						else
						{
							flags += cpu_flag::pending;
						}
					});
			}
		}

		return;
	}
	case thread_class::ppu:
		break;
	default:
		QMessageBox::warning(this, tr("Unimplemented Breakpoints For Thread Type!"), tr("Cannot set breakpoints on a thread not an PPU/SPU currently, sorry."));
		return;
	}

	if (!vm::check_addr(loc, vm::page_executable))
	{
		QMessageBox::warning(this, tr("Invalid Memory For Breakpoints!"), tr("Cannot set breakpoints on non-executable memory!"));
		return;
	}

	if (m_ppu_breakpoint_handler->HasBreakpoint(loc, breakpoint_types::bp_exec))
	{
		if (!only_add)
		{
			RemoveBreakpoint(loc);
		}
	}
	else
	{
		if (!AddBreakpoint(loc, breakpoint_types::bp_exec))
		{
			QMessageBox::warning(this, tr("Unknown error while setting breakpoint!"), tr("Failed to set breakpoints."));
			return;
		}
	}
}

void breakpoint_list::OnBreakpointListDoubleClicked()
{
	if (QListWidgetItem* item = currentItem())
	{
		const u32 address = item->data(Qt::UserRole).value<u32>();
		Q_EMIT RequestShowAddress(address);
	}
}

void breakpoint_list::OnBreakpointListRightClicked(const QPoint& pos)
{
	m_context_menu = new QMenu();

	if (selectedItems().count() == 1)
	{
		QAction* rename_action = m_context_menu->addAction(tr("&Rename"));
		connect(rename_action, &QAction::triggered, this, [this]()
			{
				QListWidgetItem* current_item = selectedItems().first();
				current_item->setFlags(current_item->flags() | Qt::ItemIsEditable);
				editItem(current_item);
			});
		m_context_menu->addSeparator();
	}

	if (selectedItems().count() >= 1)
	{
		m_context_menu->addAction(m_delete_action);
	}

	QAction* m_addbp = new QAction(tr("Add Breakpoint"), this);
	connect(m_addbp, &QAction::triggered, this, [this]
		{
			debugger_add_bp_window dlg(this, this);
			dlg.exec();
		});
	m_context_menu->addAction(m_addbp);

#ifdef RPCS3_HAS_MEMORY_BREAKPOINTS
	QAction* m_tglbpmbreak = new QAction(m_ppu_breakpoint_handler->IsBreakOnBPM() ? tr("Disable BPM") : tr("Enable BPM"), this);
	connect(m_tglbpmbreak, &QAction::triggered, [this]
		{
			m_ppu_breakpoint_handler->SetBreakOnBPM(!m_ppu_breakpoint_handler->IsBreakOnBPM());
		});
	m_context_menu->addAction(m_tglbpmbreak);
#endif

	m_context_menu->exec(viewport()->mapToGlobal(pos));
	m_context_menu->deleteLater();
	m_context_menu = nullptr;
}

void breakpoint_list::OnBreakpointListDelete()
{
	for (int i = selectedItems().count() - 1; i >= 0; i--)
	{
		RemoveBreakpoint(::at32(selectedItems(), i)->data(Qt::UserRole).value<u32>());
	}

	if (m_context_menu)
	{
		m_context_menu->close();
	}
}

void breakpoint_list::mouseDoubleClickEvent(QMouseEvent* ev)
{
	if (!ev)
		return;

	// Qt's itemDoubleClicked signal doesn't distinguish between mouse buttons and there is no simple way to get the pressed button.
	// So we have to ignore this event when another button is pressed.
	if (ev->button() != Qt::LeftButton)
	{
		ev->ignore();
		return;
	}

	QListWidget::mouseDoubleClickEvent(ev);
}