Mesen-SX/Core/SpcDebugger.cpp

#include "stdafx.h"
#include "SpcDebugger.h"
#include "DisassemblyInfo.h"
#include "Disassembler.h"
#include "Spc.h"
#include "TraceLogger.h"
#include "CallstackManager.h"
#include "BreakpointManager.h"
#include "MemoryManager.h"
#include "Debugger.h"
#include "Console.h"
#include "MemoryAccessCounter.h"
#include "ExpressionEvaluator.h"
#include "EmuSettings.h"

SpcDebugger::SpcDebugger(Debugger* debugger)
{
	_debugger = debugger;
	_traceLogger = debugger->GetTraceLogger().get();
	_disassembler = debugger->GetDisassembler().get();
	_memoryAccessCounter = debugger->GetMemoryAccessCounter().get();
	_spc = debugger->GetConsole()->GetSpc().get();
	_memoryManager = debugger->GetConsole()->GetMemoryManager().get();
	_settings = debugger->GetConsole()->GetSettings().get();

	_callstackManager.reset(new CallstackManager(debugger));
	_breakpointManager.reset(new BreakpointManager(debugger, CpuType::Spc));
	_step.reset(new StepRequest());
}

void SpcDebugger::Reset()
{
	_callstackManager.reset(new CallstackManager(_debugger));
	_prevOpCode = 0xFF;
}

void SpcDebugger::ProcessRead(uint16_t addr, uint8_t value, MemoryOperationType type)
{
	if (type == MemoryOperationType::DummyRead)
	{
		//Ignore all dummy reads for now
		return;
	}

	AddressInfo addressInfo = _spc->GetAbsoluteAddress(addr);
	MemoryOperationInfo operation{addr, value, type};
	BreakSource breakSource = BreakSource::Unspecified;

	if (type == MemoryOperationType::ExecOpCode)
	{
		SpcState spcState = _spc->GetState();

		if (_traceLogger->IsCpuLogged(CpuType::Spc) || _settings->CheckDebuggerFlag(DebuggerFlags::SpcDebuggerEnabled))
		{
			_disassembler->BuildCache(addressInfo, 0, CpuType::Spc);

			if (_traceLogger->IsCpuLogged(CpuType::Spc))
			{
				_debugger->GetState(_debugState, true);

				DisassemblyInfo disInfo = _disassembler->GetDisassemblyInfo(addressInfo, addr, 0, CpuType::Spc);
				_traceLogger->Log(CpuType::Spc, _debugState, disInfo);
			}
		}

		if (_prevOpCode == 0x3F || _prevOpCode == 0x0F)
		{
			//JSR, BRK
			uint8_t opSize = DisassemblyInfo::GetOpSize(_prevOpCode, 0, CpuType::Spc);
			uint16_t returnPc = _prevProgramCounter + opSize;
			AddressInfo src = _spc->GetAbsoluteAddress(_prevProgramCounter);
			AddressInfo ret = _spc->GetAbsoluteAddress(returnPc);
			_callstackManager->Push(src, _prevProgramCounter, addressInfo, spcState.PC, ret, returnPc,
			                        StackFrameFlags::None);
		}
		else if (_prevOpCode == 0x6F || _prevOpCode == 0x7F)
		{
			//RTS, RTI
			_callstackManager->Pop(addressInfo, spcState.PC);
		}

		if (_step->BreakAddress == (int32_t)spcState.PC && (_prevOpCode == 0x6F || _prevOpCode == 0x7F))
		{
			//RTS/RTI found, if we're on the expected return address, break immediately (for step over/step out)
			_step->StepCount = 0;
		}

		_prevOpCode = value;
		_prevProgramCounter = spcState.PC;

		if (_step->StepCount > 0)
		{
			_step->StepCount--;
		}

		if (_settings->CheckDebuggerFlag(DebuggerFlags::SpcDebuggerEnabled))
		{
			//Break on BRK/STP
			if (value == 0x0F && _settings->CheckDebuggerFlag(DebuggerFlags::BreakOnBrk))
			{
				breakSource = BreakSource::BreakOnBrk;
				_step->StepCount = 0;
			}
			else if (value == 0xFF && _settings->CheckDebuggerFlag(DebuggerFlags::BreakOnStp))
			{
				breakSource = BreakSource::BreakOnStp;
				_step->StepCount = 0;
			}
		}
		_memoryAccessCounter->ProcessMemoryExec(addressInfo, _memoryManager->GetMasterClock());
	}
	else if (type == MemoryOperationType::ExecOperand)
	{
		_memoryAccessCounter->ProcessMemoryExec(addressInfo, _memoryManager->GetMasterClock());
	}
	else
	{
		_memoryAccessCounter->ProcessMemoryRead(addressInfo, _memoryManager->GetMasterClock());
	}

	_debugger->ProcessBreakConditions(_step->StepCount == 0, GetBreakpointManager(), operation, addressInfo,
	                                  breakSource);
}

void SpcDebugger::ProcessWrite(uint16_t addr, uint8_t value, MemoryOperationType type)
{
	AddressInfo addressInfo{addr, SnesMemoryType::SpcRam}; //Writes never affect the SPC ROM
	MemoryOperationInfo operation{addr, value, type};
	_debugger->ProcessBreakConditions(false, GetBreakpointManager(), operation, addressInfo);

	_disassembler->InvalidateCache(addressInfo, CpuType::Spc);

	_memoryAccessCounter->ProcessMemoryWrite(addressInfo, _memoryManager->GetMasterClock());
}

void SpcDebugger::Run()
{
	_step.reset(new StepRequest());
}

void SpcDebugger::Step(int32_t stepCount, StepType type)
{
	StepRequest step;

	switch (type)
	{
	case StepType::Step: step.StepCount = stepCount;
		break;
	case StepType::StepOut: step.BreakAddress = _callstackManager->GetReturnAddress();
		break;
	case StepType::StepOver:
		if (_prevOpCode == 0x3F || _prevOpCode == 0x0F)
		{
			//JSR, BRK
			step.BreakAddress = _prevProgramCounter + DisassemblyInfo::GetOpSize(_prevOpCode, 0, CpuType::Spc);
		}
		else
		{
			//For any other instruction, step over is the same as step into
			step.StepCount = 1;
		}
		break;

	case StepType::SpecificScanline:
	case StepType::PpuStep:
		break;
	}

	_step.reset(new StepRequest(step));
}

shared_ptr<CallstackManager> SpcDebugger::GetCallstackManager()
{
	return _callstackManager;
}

BreakpointManager* SpcDebugger::GetBreakpointManager()
{
	return _breakpointManager.get();
}