Mesen2/Core/Debugger/Debugger.cpp
2022-09-08 21:29:52 -04:00

961 lines
34 KiB
C++

#include "pch.h"
#include "Debugger/Debugger.h"
#include "Debugger/DebugTypes.h"
#include "Debugger/DisassemblyInfo.h"
#include "Debugger/MemoryDumper.h"
#include "Debugger/MemoryAccessCounter.h"
#include "Debugger/CodeDataLogger.h"
#include "Debugger/Disassembler.h"
#include "Debugger/DisassemblySearch.h"
#include "Debugger/BreakpointManager.h"
#include "Debugger/PpuTools.h"
#include "Debugger/DebugBreakHelper.h"
#include "Debugger/LabelManager.h"
#include "Debugger/ScriptManager.h"
#include "Debugger/ScriptHost.h"
#include "Debugger/CallstackManager.h"
#include "Debugger/ExpressionEvaluator.h"
#include "Debugger/BaseEventManager.h"
#include "Debugger/TraceLogFileSaver.h"
#include "Debugger/CdlManager.h"
#include "Debugger/ITraceLogger.h"
#include "SNES/SnesCpuTypes.h"
#include "SNES/SpcTypes.h"
#include "SNES/Coprocessors/SA1/Sa1Types.h"
#include "SNES/Coprocessors/GSU/GsuTypes.h"
#include "SNES/Coprocessors/CX4/Cx4Types.h"
#include "SNES/Coprocessors/DSP/NecDspTypes.h"
#include "SNES/Debugger/SnesDebugger.h"
#include "SNES/Debugger/SpcDebugger.h"
#include "SNES/Debugger/GsuDebugger.h"
#include "SNES/Debugger/NecDspDebugger.h"
#include "SNES/Debugger/Cx4Debugger.h"
#include "NES/Debugger/NesDebugger.h"
#include "NES/NesTypes.h"
#include "Gameboy/Debugger/GbDebugger.h"
#include "Gameboy/GbTypes.h"
#include "PCE/Debugger/PceDebugger.h"
#include "PCE/PceTypes.h"
#include "Shared/BaseControlManager.h"
#include "Shared/EmuSettings.h"
#include "Shared/Audio/SoundMixer.h"
#include "Shared/NotificationManager.h"
#include "Shared/BaseState.h"
#include "Shared/Emulator.h"
#include "Shared/Interfaces/IConsole.h"
#include "Utilities/HexUtilities.h"
#include "Utilities/FolderUtilities.h"
#include "Utilities/Patches/IpsPatcher.h"
#include "MemoryOperationType.h"
#include "EventType.h"
uint64_t ITraceLogger::NextRowId = 0;
Debugger::Debugger(Emulator* emu, IConsole* console)
{
_executionStopped = true;
_emu = emu;
_console = console;
_settings = _emu->GetSettings();
_consoleType = _emu->GetConsoleType();
vector<CpuType> cpuTypes = _emu->GetCpuTypes();
_cpuTypes = unordered_set<CpuType>(cpuTypes.begin(), cpuTypes.end());
_mainCpuType = cpuTypes[0];
_labelManager.reset(new LabelManager(this));
_memoryDumper.reset(new MemoryDumper(this));
_disassembler.reset(new Disassembler(console, this));
_disassemblySearch.reset(new DisassemblySearch(_disassembler.get(), _labelManager.get()));
_memoryAccessCounter.reset(new MemoryAccessCounter(this));
_scriptManager.reset(new ScriptManager(this));
_traceLogSaver.reset(new TraceLogFileSaver());
_cdlManager.reset(new CdlManager(this, _disassembler.get()));
//Use cpuTypes for iteration (ordered), not _cpuTypes (order is important for coprocessors, etc.)
for(CpuType type : cpuTypes) {
unique_ptr<IDebugger> &debugger = _debuggers[(int)type].Debugger;
switch(type) {
case CpuType::Snes: debugger.reset(new SnesDebugger(this, CpuType::Snes)); break;
case CpuType::Spc: debugger.reset(new SpcDebugger(this)); break;
case CpuType::NecDsp: debugger.reset(new NecDspDebugger(this)); break;
case CpuType::Sa1: debugger.reset(new SnesDebugger(this, CpuType::Sa1)); break;
case CpuType::Gsu: debugger.reset(new GsuDebugger(this)); break;
case CpuType::Cx4: debugger.reset(new Cx4Debugger(this)); break;
case CpuType::Gameboy: debugger.reset(new GbDebugger(this)); break;
case CpuType::Nes: debugger.reset(new NesDebugger(this)); break;
case CpuType::Pce: debugger.reset(new PceDebugger(this)); break;
default: throw std::runtime_error("Unsupported CPU type");
}
_debuggers[(int)type].Evaluator.reset(new ExpressionEvaluator(this, _debuggers[(int)type].Debugger.get(), type));
}
for(CpuType type : _cpuTypes) {
_debuggers[(int)type].Debugger->Init();
_debuggers[(int)type].Debugger->ProcessConfigChange();
}
_breakRequestCount = 0;
_suspendRequestCount = 0;
_cdlManager->RefreshCodeCache();
if(_emu->IsPaused()) {
//Break on the current instruction if emulation was already paused
Step(_mainCpuType, 1, StepType::Step);
}
_executionStopped = false;
#ifdef _DEBUG
if(_mainCpuType == CpuType::Snes) {
ExpressionEvaluator eval(this, _debuggers[(int)CpuType::Snes].Debugger.get(), CpuType::Snes);
eval.RunTests();
}
#endif
}
Debugger::~Debugger()
{
Release();
}
void Debugger::Release()
{
while(_executionStopped) {
Run();
}
}
void Debugger::Reset()
{
_memoryAccessCounter->ResetCounts();
for(int i = 0; i <= (int)DebugUtilities::GetLastCpuType(); i++) {
if(_debuggers[i].Debugger) {
_debuggers[i].Debugger->Reset();
}
}
}
template<CpuType type, typename DebuggerType>
DebuggerType* Debugger::GetDebugger()
{
return (DebuggerType*)_debuggers[(int)type].Debugger.get();
}
template<CpuType type>
uint64_t Debugger::GetCpuCycleCount()
{
switch(type) {
case CpuType::Snes: return GetDebugger<type, SnesDebugger>()->GetCpuCycleCount();
case CpuType::Spc: return GetDebugger<type, SpcDebugger>()->GetCpuCycleCount();
case CpuType::NecDsp: return GetDebugger<type, NecDspDebugger>()->GetCpuCycleCount();
case CpuType::Sa1: return GetDebugger<type, SnesDebugger>()->GetCpuCycleCount();
case CpuType::Gsu: return GetDebugger<type, GsuDebugger>()->GetCpuCycleCount();
case CpuType::Cx4: return GetDebugger<type, Cx4Debugger>()->GetCpuCycleCount();
case CpuType::Gameboy: return GetDebugger<type, GbDebugger>()->GetCpuCycleCount();
case CpuType::Nes: return GetDebugger<type, NesDebugger>()->GetCpuCycleCount();
case CpuType::Pce: return GetDebugger<type, PceDebugger>()->GetCpuCycleCount();
default: return 0; break;
}
}
template<CpuType type>
void Debugger::ProcessInstruction()
{
_debuggers[(int)type].Debugger->IgnoreBreakpoints = false;
_debuggers[(int)type].Debugger->AllowChangeProgramCounter = true;
switch(type) {
case CpuType::Snes: GetDebugger<type, SnesDebugger>()->ProcessInstruction(); break;
case CpuType::Spc: GetDebugger<type, SpcDebugger>()->ProcessInstruction(); break;
case CpuType::NecDsp: GetDebugger<type, NecDspDebugger>()->ProcessInstruction(); break;
case CpuType::Sa1: GetDebugger<type, SnesDebugger>()->ProcessInstruction(); break;
case CpuType::Gsu: GetDebugger<type, GsuDebugger>()->ProcessInstruction(); break;
case CpuType::Cx4: GetDebugger<type, Cx4Debugger>()->ProcessInstruction(); break;
case CpuType::Gameboy: GetDebugger<type, GbDebugger>()->ProcessInstruction(); break;
case CpuType::Nes: GetDebugger<type, NesDebugger>()->ProcessInstruction(); break;
case CpuType::Pce: GetDebugger<type, PceDebugger>()->ProcessInstruction(); break;
}
_debuggers[(int)type].Debugger->AllowChangeProgramCounter = false;
if(_scriptManager->HasCpuMemoryCallbacks()) {
MemoryOperationInfo memOp = _debuggers[(int)type].Debugger->InstructionProgress.LastMemOperation;
AddressInfo relAddr = { (int32_t)memOp.Address, memOp.MemType };
uint8_t value = (uint8_t)memOp.Value;
_scriptManager->ProcessMemoryOperation(relAddr, value, MemoryOperationType::ExecOpCode, type, true);
}
}
template<CpuType type, typename T>
void Debugger::ProcessMemoryRead(uint32_t addr, T& value, MemoryOperationType opType)
{
switch(type) {
case CpuType::Snes: GetDebugger<type, SnesDebugger>()->ProcessRead(addr, value, opType); break;
case CpuType::Spc: GetDebugger<type, SpcDebugger>()->ProcessRead(addr, value, opType); break;
case CpuType::NecDsp: GetDebugger<type, NecDspDebugger>()->ProcessRead(addr, value, opType); break;
case CpuType::Sa1: GetDebugger<type, SnesDebugger>()->ProcessRead(addr, value, opType); break;
case CpuType::Gsu: GetDebugger<type, GsuDebugger>()->ProcessRead(addr, value, opType); break;
case CpuType::Cx4: GetDebugger<type, Cx4Debugger>()->ProcessRead(addr, value, opType); break;
case CpuType::Gameboy: GetDebugger<type, GbDebugger>()->ProcessRead(addr, value, opType); break;
case CpuType::Nes: GetDebugger<type, NesDebugger>()->ProcessRead(addr, value, opType); break;
case CpuType::Pce: GetDebugger<type, PceDebugger>()->ProcessRead(addr, value, opType); break;
}
if(_scriptManager->HasCpuMemoryCallbacks()) {
ProcessScripts<type>(addr, value, opType);
}
}
template<CpuType type, typename T>
void Debugger::ProcessMemoryWrite(uint32_t addr, T& value, MemoryOperationType opType)
{
switch(type) {
case CpuType::Snes: GetDebugger<type, SnesDebugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::Spc: GetDebugger<type, SpcDebugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::NecDsp: GetDebugger<type, NecDspDebugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::Sa1: GetDebugger<type, SnesDebugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::Gsu: GetDebugger<type, GsuDebugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::Cx4: GetDebugger<type, Cx4Debugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::Gameboy: GetDebugger<type, GbDebugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::Nes: GetDebugger<type, NesDebugger>()->ProcessWrite(addr, value, opType); break;
case CpuType::Pce: GetDebugger<type, PceDebugger>()->ProcessWrite(addr, value, opType); break;
}
if(_scriptManager->HasCpuMemoryCallbacks()) {
ProcessScripts<type>(addr, value, opType);
}
}
template<CpuType type>
void Debugger::ProcessIdleCycle()
{
_debuggers[(int)type].Debugger->InstructionProgress.LastMemOperation.Type = MemoryOperationType::Idle;
switch(type) {
case CpuType::Snes: GetDebugger<type, SnesDebugger>()->ProcessIdleCycle(); break;
case CpuType::Sa1: GetDebugger<type, SnesDebugger>()->ProcessIdleCycle(); break;
}
}
template<CpuType type, typename T>
void Debugger::ProcessPpuRead(uint16_t addr, T& value, MemoryType memoryType, MemoryOperationType opType)
{
switch(type) {
case CpuType::Snes: GetDebugger<type, SnesDebugger>()->ProcessPpuRead(addr, value, memoryType); break;
case CpuType::Gameboy: GetDebugger<type, GbDebugger>()->ProcessPpuRead(addr, value, memoryType); break;
case CpuType::Nes: GetDebugger<type, NesDebugger>()->ProcessPpuRead(addr, value, memoryType, opType); break;
case CpuType::Pce: GetDebugger<type, PceDebugger>()->ProcessPpuRead(addr, value, memoryType); break;
default: throw std::runtime_error("Invalid cpu type");
}
if(_scriptManager->HasPpuMemoryCallbacks()) {
ProcessScripts<type>(addr, value, memoryType, opType);
}
}
template<CpuType type, typename T>
void Debugger::ProcessPpuWrite(uint16_t addr, T& value, MemoryType memoryType)
{
switch(type) {
case CpuType::Snes: GetDebugger<type, SnesDebugger>()->ProcessPpuWrite(addr, value, memoryType); break;
case CpuType::Gameboy: GetDebugger<type, GbDebugger>()->ProcessPpuWrite(addr, value, memoryType); break;
case CpuType::Nes: GetDebugger<type, NesDebugger>()->ProcessPpuWrite(addr, value, memoryType); break;
case CpuType::Pce: GetDebugger<type, PceDebugger>()->ProcessPpuWrite(addr, value, memoryType); break;
default: throw std::runtime_error("Invalid cpu type");
}
if(_scriptManager->HasPpuMemoryCallbacks()) {
ProcessScripts<type>(addr, value, memoryType, MemoryOperationType::Write);
}
}
template<CpuType type>
void Debugger::ProcessPpuCycle()
{
switch(type) {
case CpuType::Snes: GetDebugger<type, SnesDebugger>()->ProcessPpuCycle(); break;
case CpuType::Gameboy: GetDebugger<type, GbDebugger>()->ProcessPpuCycle(); break;
case CpuType::Nes: GetDebugger<type, NesDebugger>()->ProcessPpuCycle(); break;
case CpuType::Pce: GetDebugger<type, PceDebugger>()->ProcessPpuCycle(); break;
default: throw std::runtime_error("Invalid cpu type");
}
}
void Debugger::SleepUntilResume(CpuType sourceCpu, BreakSource source, MemoryOperationInfo *operation, int breakpointId)
{
if(_suspendRequestCount) {
return;
}
_executionStopped = true;
bool notificationSent = false;
if(source != BreakSource::Unspecified || _breakRequestCount == 0) {
_emu->GetSoundMixer()->StopAudio();
if(_settings->GetDebugConfig().SingleBreakpointPerInstruction) {
_debuggers[(int)sourceCpu].Debugger->IgnoreBreakpoints = true;
}
if(_settings->GetDebugConfig().DrawPartialFrame) {
_debuggers[(int)sourceCpu].Debugger->DrawPartialFrame();
}
//Only trigger code break event if the pause was caused by user action
BreakEvent evt = {};
evt.SourceCpu = sourceCpu;
evt.BreakpointId = breakpointId;
evt.Source = source;
if(operation) {
evt.Operation = *operation;
}
_waitForBreakResume = true;
_emu->GetNotificationManager()->SendNotification(ConsoleNotificationType::CodeBreak, &evt);
ProcessEvent(EventType::CodeBreak);
notificationSent = true;
}
while((_waitForBreakResume && !_suspendRequestCount) || _breakRequestCount) {
std::this_thread::sleep_for(std::chrono::duration<int, std::milli>(_breakRequestCount ? 1 : 10));
}
if(notificationSent) {
_emu->GetNotificationManager()->SendNotification(ConsoleNotificationType::DebuggerResumed);
}
_executionStopped = false;
}
void Debugger::ProcessBreakConditions(CpuType sourceCpu, StepRequest& step, BreakpointManager* bpManager, MemoryOperationInfo& operation, AddressInfo& addressInfo)
{
int breakpointId = bpManager->CheckBreakpoint(operation, addressInfo, true);
if(_breakRequestCount || _waitForBreakResume || (step.BreakNeeded && (!_debuggers[(int)sourceCpu].Debugger->IgnoreBreakpoints || step.Type == StepType::CpuCycleStep))) {
SleepUntilResume(sourceCpu, step.Source);
} else {
if(breakpointId >= 0 && !_debuggers[(int)sourceCpu].Debugger->IgnoreBreakpoints) {
SleepUntilResume(sourceCpu, BreakSource::Breakpoint, &operation, breakpointId);
}
}
}
void Debugger::ProcessPredictiveBreakpoint(CpuType sourceCpu, BreakpointManager* bpManager, MemoryOperationInfo& operation, AddressInfo& addressInfo)
{
if(_debuggers[(int)sourceCpu].Debugger->IgnoreBreakpoints) {
return;
}
int breakpointId = bpManager->CheckBreakpoint(operation, addressInfo, false);
if(breakpointId >= 0) {
SleepUntilResume(sourceCpu, BreakSource::Breakpoint, &operation, breakpointId);
}
}
template<CpuType type>
void Debugger::ProcessInterrupt(uint32_t originalPc, uint32_t currentPc, bool forNmi)
{
_debuggers[(int)type].Debugger->ProcessInterrupt(originalPc, currentPc, forNmi);
ProcessEvent(forNmi ? EventType::Nmi : EventType::Irq);
}
void Debugger::InternalProcessInterrupt(CpuType cpuType, IDebugger& dbg, StepRequest& stepRequest, AddressInfo& src, uint32_t srcAddr, AddressInfo& dest, uint32_t destAddr, AddressInfo& ret, uint32_t retAddr, bool forNmi)
{
dbg.GetCallstackManager()->Push(src, srcAddr, dest, destAddr, ret, retAddr, forNmi ? StackFrameFlags::Nmi : StackFrameFlags::Irq);
dbg.GetEventManager()->AddEvent(forNmi ? DebugEventType::Nmi : DebugEventType::Irq);
stepRequest.ProcessNmiIrq(forNmi);
}
void Debugger::ProcessEvent(EventType type)
{
_scriptManager->ProcessEvent(type);
switch(type) {
default: break;
case EventType::InputPolled:
_debuggers[(int)_mainCpuType].Debugger->ProcessInputOverrides(_inputOverrides);
break;
case EventType::StartFrame: {
_emu->GetNotificationManager()->SendNotification(ConsoleNotificationType::EventViewerRefresh, (void*)_mainCpuType);
BaseEventManager* evtMgr = GetEventManager(_mainCpuType);
if(evtMgr) {
evtMgr->ClearFrameEvents();
}
break;
}
//TODO (need a better solution)
case EventType::GbStartFrame:
if(_consoleType == ConsoleType::Gameboy || _consoleType == ConsoleType::GameboyColor) {
_scriptManager->ProcessEvent(EventType::StartFrame);
}
_emu->GetNotificationManager()->SendNotification(ConsoleNotificationType::EventViewerRefresh, (void*)CpuType::Gameboy);
GetEventManager(CpuType::Gameboy)->ClearFrameEvents();
break;
//TODO (need a better solution)
case EventType::GbEndFrame:
if(_consoleType == ConsoleType::Gameboy || _consoleType == ConsoleType::GameboyColor) {
_scriptManager->ProcessEvent(EventType::EndFrame);
}
break;
case EventType::Reset:
Reset();
break;
case EventType::StateLoaded:
_memoryAccessCounter->ResetCounts();
break;
}
}
template<CpuType type, typename T>
void Debugger::ProcessScripts(uint32_t addr, T& value, MemoryOperationType opType)
{
MemoryOperationInfo memOp = GetDebugger<type, IDebugger>()->InstructionProgress.LastMemOperation;
AddressInfo relAddr = { (int32_t)memOp.Address, memOp.MemType };
if constexpr(std::is_same<T, uint8_t>::value) {
_scriptManager->ProcessMemoryOperation(relAddr, value, opType, type, false);
} else {
//TODO NEC DSP
uint8_t val = (uint8_t)value;
_scriptManager->ProcessMemoryOperation(relAddr, val, opType, type, false);
}
}
template<CpuType type, typename T>
void Debugger::ProcessScripts(uint32_t addr, T& value, MemoryType memType, MemoryOperationType opType)
{
AddressInfo relAddr = { (int32_t)addr, memType };
if constexpr(std::is_same<T, uint8_t>::value) {
_scriptManager->ProcessMemoryOperation(relAddr, value, opType, type, false);
} else {
//TODO NEC DSP and PCE VDC
uint8_t val = (uint8_t)value;
_scriptManager->ProcessMemoryOperation(relAddr, val, opType, type, false);
}
}
void Debugger::ProcessConfigChange()
{
for(int i = 0; i <= (int)DebugUtilities::GetLastCpuType(); i++) {
if(_debuggers[i].Debugger) {
_debuggers[i].Debugger->ProcessConfigChange();
}
}
}
void Debugger::GetTokenList(CpuType cpuType, char* tokenList)
{
ExpressionEvaluator expEval(this, nullptr, cpuType);
expEval.GetTokenList(tokenList);
}
int32_t Debugger::EvaluateExpression(string expression, CpuType cpuType, EvalResultType &resultType, bool useCache)
{
MemoryOperationInfo operationInfo { 0, 0, MemoryOperationType::Read, MemoryType::None };
if(useCache && _debuggers[(int)cpuType].Evaluator) {
return _debuggers[(int)cpuType].Evaluator->Evaluate(expression, resultType, operationInfo);
} else if(_debuggers[(int)cpuType].Debugger) {
ExpressionEvaluator expEval(this, _debuggers[(int)cpuType].Debugger.get(), cpuType);
return expEval.Evaluate(expression, resultType, operationInfo);
}
resultType = EvalResultType::Invalid;
return 0;
}
void Debugger::Run()
{
for(int i = 0; i <= (int)DebugUtilities::GetLastCpuType(); i++) {
if(_debuggers[i].Debugger) {
_debuggers[i].Debugger->Run();
}
}
_waitForBreakResume = false;
}
void Debugger::PauseOnNextFrame()
{
//Use BreakSource::PpuStep to prevent "Run single frame" from triggering the "bring to front on pause" feature
switch(_mainCpuType) {
case CpuType::Snes: Step(CpuType::Snes, 240, StepType::SpecificScanline, BreakSource::PpuStep); break;
case CpuType::Gameboy: Step(CpuType::Gameboy, 144, StepType::SpecificScanline, BreakSource::PpuStep); break;
case CpuType::Nes: Step(CpuType::Nes, 240, StepType::SpecificScanline, BreakSource::PpuStep); break;
case CpuType::Pce: Step(CpuType::Pce, 243, StepType::SpecificScanline, BreakSource::PpuStep); break;
}
}
void Debugger::Step(CpuType cpuType, int32_t stepCount, StepType type, BreakSource source)
{
DebugBreakHelper helper(this);
IDebugger* debugger = _debuggers[(int)cpuType].Debugger.get();
if(debugger) {
debugger->Step(stepCount, type);
debugger->GetStepRequest()->SetBreakSource(source);
}
for(int i = 0; i <= (int)DebugUtilities::GetLastCpuType(); i++) {
if(_debuggers[i].Debugger && _debuggers[i].Debugger.get() != debugger) {
_debuggers[i].Debugger->Run();
}
}
_waitForBreakResume = false;
}
bool Debugger::IsPaused()
{
return _waitForBreakResume;
}
bool Debugger::IsExecutionStopped()
{
return _executionStopped || _emu->IsThreadPaused();
}
bool Debugger::HasBreakRequest()
{
return _breakRequestCount > 0;
}
void Debugger::BreakRequest(bool release)
{
if(release) {
_breakRequestCount--;
} else {
_breakRequestCount++;
}
}
void Debugger::ResetSuspendCounter()
{
_suspendRequestCount = 0;
}
void Debugger::SuspendDebugger(bool release)
{
if(release) {
if(_suspendRequestCount > 0) {
_suspendRequestCount--;
} else {
#ifdef _DEBUG
//throw std::runtime_error("unexpected debugger suspend::release call");
#endif
}
} else {
_suspendRequestCount++;
}
}
bool Debugger::IsDebugWindowOpened(CpuType cpuType)
{
switch(cpuType) {
case CpuType::Snes: return _settings->CheckDebuggerFlag(DebuggerFlags::SnesDebuggerEnabled);
case CpuType::Spc: return _settings->CheckDebuggerFlag(DebuggerFlags::SpcDebuggerEnabled);
case CpuType::NecDsp: return _settings->CheckDebuggerFlag(DebuggerFlags::NecDspDebuggerEnabled);
case CpuType::Sa1: return _settings->CheckDebuggerFlag(DebuggerFlags::Sa1DebuggerEnabled);
case CpuType::Gsu: return _settings->CheckDebuggerFlag(DebuggerFlags::GsuDebuggerEnabled);
case CpuType::Cx4: return _settings->CheckDebuggerFlag(DebuggerFlags::Cx4DebuggerEnabled);
case CpuType::Gameboy: return _settings->CheckDebuggerFlag(DebuggerFlags::GbDebuggerEnabled);
case CpuType::Nes: return _settings->CheckDebuggerFlag(DebuggerFlags::NesDebuggerEnabled);
case CpuType::Pce: return _settings->CheckDebuggerFlag(DebuggerFlags::PceDebuggerEnabled);
}
return false;
}
bool Debugger::IsBreakOptionEnabled(BreakSource src)
{
switch(src) {
case BreakSource::GbDisableLcdOutsideVblank: return _settings->GetDebugConfig().GbBreakOnDisableLcdOutsideVblank;
case BreakSource::GbInvalidVramAccess: return _settings->GetDebugConfig().GbBreakOnInvalidVramAccess;
case BreakSource::GbInvalidOamAccess: return _settings->GetDebugConfig().GbBreakOnInvalidOamAccess;
case BreakSource::NesBreakOnDecayedOamRead: return _settings->GetDebugConfig().NesBreakOnDecayedOamRead;
case BreakSource::NesBreakOnPpu2000ScrollGlitch: return _settings->GetDebugConfig().NesBreakOnPpu2000ScrollGlitch;
case BreakSource::NesBreakOnPpu2006ScrollGlitch: return _settings->GetDebugConfig().NesBreakOnPpu2006ScrollGlitch;
case BreakSource::NesBusConflict: return _settings->GetDebugConfig().NesBreakOnBusConflict;
case BreakSource::NesBreakOnCpuCrash: return _settings->GetDebugConfig().NesBreakOnCpuCrash;
case BreakSource::PceBreakOnInvalidVramAddress: return _settings->GetDebugConfig().PceBreakOnInvalidVramAddress;
}
return false;
}
void Debugger::BreakImmediately(CpuType sourceCpu, BreakSource source)
{
if(IsDebugWindowOpened(sourceCpu) && IsBreakOptionEnabled(source)) {
SleepUntilResume(sourceCpu, source);
}
}
void Debugger::GetCpuState(BaseState &dstState, CpuType cpuType)
{
BaseState& srcState = GetCpuStateRef(cpuType);
switch(cpuType) {
case CpuType::Snes: memcpy(&dstState, &srcState, sizeof(SnesCpuState)); break;
case CpuType::Spc: memcpy(&dstState, &srcState, sizeof(SpcState)); break;
case CpuType::NecDsp: memcpy(&dstState, &srcState, sizeof(NecDspState)); break;
case CpuType::Sa1: memcpy(&dstState, &srcState, sizeof(SnesCpuState)); break;
case CpuType::Gsu: memcpy(&dstState, &srcState, sizeof(GsuState)); break;
case CpuType::Cx4: memcpy(&dstState, &srcState, sizeof(Cx4State)); break;
case CpuType::Gameboy: memcpy(&dstState, &srcState, sizeof(GbCpuState)); break;
case CpuType::Nes: memcpy(&dstState, &srcState, sizeof(NesCpuState)); break;
case CpuType::Pce: memcpy(&dstState, &srcState, sizeof(PceCpuState)); break;
}
}
void Debugger::SetCpuState(BaseState& srcState, CpuType cpuType)
{
DebugBreakHelper helper(this);
BaseState& dstState = GetCpuStateRef(cpuType);
switch(cpuType) {
case CpuType::Snes: memcpy(&dstState, &srcState, sizeof(SnesCpuState)); break;
case CpuType::Spc: memcpy(&dstState, &srcState, sizeof(SpcState)); break;
case CpuType::NecDsp: memcpy(&dstState, &srcState, sizeof(NecDspState)); break;
case CpuType::Sa1: memcpy(&dstState, &srcState, sizeof(SnesCpuState)); break;
case CpuType::Gsu: memcpy(&dstState, &srcState, sizeof(GsuState)); break;
case CpuType::Cx4: memcpy(&dstState, &srcState, sizeof(Cx4State)); break;
case CpuType::Gameboy: memcpy(&dstState, &srcState, sizeof(GbCpuState)); break;
case CpuType::Nes: memcpy(&dstState, &srcState, sizeof(NesCpuState)); break;
case CpuType::Pce: memcpy(&dstState, &srcState, sizeof(PceCpuState)); break;
}
}
BaseState& Debugger::GetCpuStateRef(CpuType cpuType)
{
return _debuggers[(int)cpuType].Debugger->GetState();
}
void Debugger::GetPpuState(BaseState& state, CpuType cpuType)
{
switch(cpuType) {
case CpuType::Snes:
case CpuType::Spc:
case CpuType::NecDsp:
case CpuType::Sa1:
case CpuType::Gsu:
case CpuType::Cx4: {
GetDebugger<CpuType::Snes, SnesDebugger>()->GetPpuState(state);
break;
}
case CpuType::Gameboy: {
GetDebugger<CpuType::Gameboy, GbDebugger>()->GetPpuState(state);
break;
}
case CpuType::Nes: {
GetDebugger<CpuType::Nes, NesDebugger>()->GetPpuState(state);
break;
}
case CpuType::Pce: {
GetDebugger<CpuType::Pce, PceDebugger>()->GetPpuState(state);
break;
}
}
}
void Debugger::SetPpuState(BaseState& state, CpuType cpuType)
{
DebugBreakHelper helper(this);
switch(cpuType) {
case CpuType::Snes:
case CpuType::Spc:
case CpuType::NecDsp:
case CpuType::Sa1:
case CpuType::Gsu:
case CpuType::Cx4: {
GetDebugger<CpuType::Snes, SnesDebugger>()->SetPpuState(state);
break;
}
case CpuType::Gameboy: {
GetDebugger<CpuType::Gameboy, GbDebugger>()->SetPpuState(state);
break;
}
case CpuType::Nes: {
GetDebugger<CpuType::Nes, NesDebugger>()->SetPpuState(state);
break;
}
case CpuType::Pce: {
GetDebugger<CpuType::Pce, PceDebugger>()->SetPpuState(state);
break;
}
}
}
void Debugger::GetConsoleState(BaseState& state, ConsoleType consoleType)
{
_console->GetConsoleState(state, consoleType);
}
DebuggerFeatures Debugger::GetDebuggerFeatures(CpuType cpuType)
{
if(_debuggers[(int)cpuType].Debugger) {
return _debuggers[(int)cpuType].Debugger->GetSupportedFeatures();
}
return {};
}
void Debugger::SetProgramCounter(CpuType cpuType, uint32_t addr)
{
if(_debuggers[(int)cpuType].Debugger->AllowChangeProgramCounter) {
_debuggers[(int)cpuType].Debugger->SetProgramCounter(addr);
}
}
uint32_t Debugger::GetProgramCounter(CpuType cpuType, bool getInstPc)
{
return _debuggers[(int)cpuType].Debugger->GetProgramCounter(getInstPc);
}
CpuInstructionProgress Debugger::GetInstructionProgress(CpuType cpuType)
{
CpuInstructionProgress progress = _debuggers[(int)cpuType].Debugger->InstructionProgress;
progress.CurrentCycle = _debuggers[(int)cpuType].Debugger->GetCpuCycleCount();
return progress;
}
AddressInfo Debugger::GetAbsoluteAddress(AddressInfo relAddress)
{
return _console->GetAbsoluteAddress(relAddress);
}
AddressInfo Debugger::GetRelativeAddress(AddressInfo absAddress, CpuType cpuType)
{
return _console->GetRelativeAddress(absAddress, cpuType);
}
bool Debugger::HasCpuType(CpuType cpuType)
{
return _cpuTypes.find(cpuType) != _cpuTypes.end();
}
void Debugger::SetBreakpoints(Breakpoint breakpoints[], uint32_t length)
{
DebugBreakHelper helper(this);
for(int i = 0; i <= (int)DebugUtilities::GetLastCpuType(); i++) {
if(_debuggers[i].Debugger) {
_debuggers[i].Debugger->GetBreakpointManager()->SetBreakpoints(breakpoints, length);
}
}
}
void Debugger::SetInputOverrides(uint32_t index, DebugControllerState state)
{
_inputOverrides[index] = state;
}
void Debugger::GetAvailableInputOverrides(uint8_t* availableIndexes)
{
BaseControlManager* controlManager = _console->GetControlManager();
for(int i = 0; i < 8; i++) {
availableIndexes[i] = controlManager->GetControlDeviceByIndex(i) != nullptr;
}
}
void Debugger::Log(string message)
{
auto lock = _logLock.AcquireSafe();
if(_debuggerLog.size() >= 1000) {
_debuggerLog.pop_front();
}
_debuggerLog.push_back(message);
}
string Debugger::GetLog()
{
auto lock = _logLock.AcquireSafe();
stringstream ss;
for(string& msg : _debuggerLog) {
ss << msg << "\n";
}
return ss.str();
}
void Debugger::SaveRomToDisk(string filename, bool saveAsIps, CdlStripOption stripOption)
{
switch(_mainCpuType) {
case CpuType::Snes:
if(_debuggers[(int)CpuType::Gameboy].Debugger) {
//SGB
GetDebugger<CpuType::Gameboy, GbDebugger>()->SaveRomToDisk(filename, saveAsIps, stripOption);
} else {
GetDebugger<CpuType::Snes, SnesDebugger>()->SaveRomToDisk(filename, saveAsIps, stripOption);
}
break;
case CpuType::Gameboy:
GetDebugger<CpuType::Gameboy, GbDebugger>()->SaveRomToDisk(filename, saveAsIps, stripOption);
break;
case CpuType::Nes:
GetDebugger<CpuType::Nes, NesDebugger>()->SaveRomToDisk(filename, saveAsIps, stripOption);
break;
case CpuType::Pce:
GetDebugger<CpuType::Pce, PceDebugger>()->SaveRomToDisk(filename, saveAsIps, stripOption);
break;
}
}
ITraceLogger* Debugger::GetTraceLogger(CpuType cpuType)
{
if(_debuggers[(int)cpuType].Debugger) {
return _debuggers[(int)cpuType].Debugger->GetTraceLogger();
}
return nullptr;
}
void Debugger::ClearExecutionTrace()
{
DebugBreakHelper helper(this);
for(CpuType cpuType : _cpuTypes) {
ITraceLogger* logger = GetTraceLogger(cpuType);
logger->Clear();
}
}
uint32_t Debugger::GetExecutionTrace(TraceRow output[], uint32_t startOffset, uint32_t maxLineCount)
{
DebugBreakHelper helper(this);
uint32_t offsetsByCpu[(int)DebugUtilities::GetLastCpuType() + 1] = {};
uint32_t count = 0;
int64_t lastRowId = ITraceLogger::NextRowId;
while(count < maxLineCount) {
bool added = false;
for(CpuType cpuType : _cpuTypes) {
ITraceLogger* logger = GetTraceLogger(cpuType);
if(logger) {
uint32_t& offset = offsetsByCpu[(int)cpuType];
int64_t rowId = logger->GetRowId(offset);
if(rowId == -1 || rowId != lastRowId - 1) {
continue;
}
lastRowId = rowId;
if(startOffset > 0) {
//Skip rows until the part the UI wants to display is reached
startOffset--;
} else {
if(logger->IsEnabled()) {
if(output) {
logger->GetExecutionTrace(output[count], offset);
}
count++;
}
}
offset++;
added = true;
break;
}
}
if(!added) {
break;
}
}
return count;
}
PpuTools* Debugger::GetPpuTools(CpuType cpuType)
{
if(_debuggers[(int)cpuType].Debugger) {
return _debuggers[(int)cpuType].Debugger->GetPpuTools();
}
return nullptr;
}
BaseEventManager* Debugger::GetEventManager(CpuType cpuType)
{
if(_debuggers[(int)cpuType].Debugger) {
return _debuggers[(int)cpuType].Debugger->GetEventManager();
}
return nullptr;
}
CallstackManager* Debugger::GetCallstackManager(CpuType cpuType)
{
if(_debuggers[(int)cpuType].Debugger) {
return _debuggers[(int)cpuType].Debugger->GetCallstackManager();
}
return nullptr;
}
IAssembler* Debugger::GetAssembler(CpuType cpuType)
{
if(_debuggers[(int)cpuType].Debugger) {
return _debuggers[(int)cpuType].Debugger->GetAssembler();
}
return nullptr;
}
template void Debugger::ProcessInstruction<CpuType::Snes>();
template void Debugger::ProcessInstruction<CpuType::Sa1>();
template void Debugger::ProcessInstruction<CpuType::Spc>();
template void Debugger::ProcessInstruction<CpuType::Gsu>();
template void Debugger::ProcessInstruction<CpuType::NecDsp>();
template void Debugger::ProcessInstruction<CpuType::Cx4>();
template void Debugger::ProcessInstruction<CpuType::Gameboy>();
template void Debugger::ProcessInstruction<CpuType::Nes>();
template void Debugger::ProcessInstruction<CpuType::Pce>();
template void Debugger::ProcessMemoryRead<CpuType::Snes>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::Sa1>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::Spc>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::Gsu>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::NecDsp>(uint32_t addr, uint32_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::Cx4>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::Gameboy>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::Nes>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryRead<CpuType::Pce>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Snes>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Sa1>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Spc>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Gsu>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::NecDsp>(uint32_t addr, uint32_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Cx4>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Gameboy>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Nes>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessMemoryWrite<CpuType::Pce>(uint32_t addr, uint8_t& value, MemoryOperationType opType);
template void Debugger::ProcessIdleCycle<CpuType::Snes>();
template void Debugger::ProcessIdleCycle<CpuType::Sa1>();
template void Debugger::ProcessInterrupt<CpuType::Snes>(uint32_t originalPc, uint32_t currentPc, bool forNmi);
template void Debugger::ProcessInterrupt<CpuType::Sa1>(uint32_t originalPc, uint32_t currentPc, bool forNmi);
template void Debugger::ProcessInterrupt<CpuType::Gameboy>(uint32_t originalPc, uint32_t currentPc, bool forNmi);
template void Debugger::ProcessInterrupt<CpuType::Nes>(uint32_t originalPc, uint32_t currentPc, bool forNmi);
template void Debugger::ProcessInterrupt<CpuType::Pce>(uint32_t originalPc, uint32_t currentPc, bool forNmi);
template void Debugger::ProcessPpuRead<CpuType::Snes>(uint16_t addr, uint8_t& value, MemoryType memoryType, MemoryOperationType opType);
template void Debugger::ProcessPpuRead<CpuType::Gameboy>(uint16_t addr, uint8_t& value, MemoryType memoryType, MemoryOperationType opType);
template void Debugger::ProcessPpuRead<CpuType::Nes>(uint16_t addr, uint8_t& value, MemoryType memoryType, MemoryOperationType opType);
template void Debugger::ProcessPpuRead<CpuType::Pce>(uint16_t addr, uint16_t& value, MemoryType memoryType, MemoryOperationType opType);
template void Debugger::ProcessPpuRead<CpuType::Pce>(uint16_t addr, uint8_t& value, MemoryType memoryType, MemoryOperationType opType);
template void Debugger::ProcessPpuWrite<CpuType::Snes>(uint16_t addr, uint8_t& value, MemoryType memoryType);
template void Debugger::ProcessPpuWrite<CpuType::Gameboy>(uint16_t addr, uint8_t& value, MemoryType memoryType);
template void Debugger::ProcessPpuWrite<CpuType::Nes>(uint16_t addr, uint8_t& value, MemoryType memoryType);
template void Debugger::ProcessPpuWrite<CpuType::Pce>(uint16_t addr, uint16_t& value, MemoryType memoryType);
template void Debugger::ProcessPpuWrite<CpuType::Pce>(uint16_t addr, uint8_t& value, MemoryType memoryType);
template void Debugger::ProcessPpuCycle<CpuType::Snes>();
template void Debugger::ProcessPpuCycle<CpuType::Gameboy>();
template void Debugger::ProcessPpuCycle<CpuType::Nes>();
template void Debugger::ProcessPpuCycle<CpuType::Pce>();