// Copyright 2009 Dolphin Emulator Project // Licensed under GPLv2+ // Refer to the license.txt file included. #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "Common/CommonPaths.h" #include "Common/CommonTypes.h" #include "Common/FileUtil.h" #include "Common/IniFile.h" #include "Common/MsgHandler.h" #include "Common/SymbolDB.h" #include "Core/Boot/Boot.h" #include "Core/ConfigManager.h" #include "Core/Core.h" #include "Core/Debugger/RSO.h" #include "Core/HLE/HLE.h" #include "Core/Host.h" #include "Core/PowerPC/JitInterface.h" #include "Core/PowerPC/PPCAnalyst.h" #include "Core/PowerPC/PPCSymbolDB.h" #include "Core/PowerPC/PowerPC.h" #include "Core/PowerPC/Profiler.h" #include "Core/PowerPC/SignatureDB/MEGASignatureDB.h" #include "Core/PowerPC/SignatureDB/SignatureDB.h" #include "DolphinWX/Debugger/BreakpointWindow.h" #include "DolphinWX/Debugger/CodeWindow.h" #include "DolphinWX/Debugger/DSPDebugWindow.h" #include "DolphinWX/Debugger/DebuggerPanel.h" #include "DolphinWX/Debugger/DebuggerUIUtil.h" #include "DolphinWX/Debugger/JitWindow.h" #include "DolphinWX/Debugger/MemoryWindow.h" #include "DolphinWX/Debugger/RegisterWindow.h" #include "DolphinWX/Debugger/WatchWindow.h" #include "DolphinWX/Frame.h" #include "DolphinWX/Globals.h" #include "DolphinWX/WxUtils.h" // Save and load settings // ----------------------------- void CCodeWindow::Load() { IniFile ini; ini.Load(File::GetUserPath(F_DEBUGGERCONFIG_IDX)); // The font to override DebuggerFont with std::string fontDesc; auto& config_instance = SConfig::GetInstance(); IniFile::Section* general = ini.GetOrCreateSection("General"); general->Get("DebuggerFont", &fontDesc); general->Get("AutomaticStart", &config_instance.bAutomaticStart, false); general->Get("BootToPause", &config_instance.bBootToPause, true); if (!fontDesc.empty()) DebuggerFont.SetNativeFontInfoUserDesc(StrToWxStr(fontDesc)); const char* SettingName[] = {"Log", "LogConfig", "Console", "Registers", "Breakpoints", "Memory", "JIT", "Sound", "Video", "Code"}; // Decide what windows to show for (int i = 0; i <= IDM_VIDEO_WINDOW - IDM_LOG_WINDOW; i++) ini.GetOrCreateSection("ShowOnStart")->Get(SettingName[i], &bShowOnStart[i], false); // Get notebook affiliation std::string section = "P - " + ((Parent->m_active_perspective < Parent->m_perspectives.size()) ? Parent->m_perspectives[Parent->m_active_perspective].name : "Perspective 1"); for (int i = 0; i <= IDM_CODE_WINDOW - IDM_LOG_WINDOW; i++) ini.GetOrCreateSection(section)->Get(SettingName[i], &iNbAffiliation[i], 0); // Get floating setting for (int i = 0; i <= IDM_CODE_WINDOW - IDM_LOG_WINDOW; i++) ini.GetOrCreateSection("Float")->Get(SettingName[i], &Parent->m_float_window[i], false); } void CCodeWindow::Save() { IniFile ini; ini.Load(File::GetUserPath(F_DEBUGGERCONFIG_IDX)); IniFile::Section* general = ini.GetOrCreateSection("General"); general->Set("DebuggerFont", WxStrToStr(DebuggerFont.GetNativeFontInfoUserDesc())); general->Set("AutomaticStart", GetParentMenuBar()->IsChecked(IDM_AUTOMATIC_START)); general->Set("BootToPause", GetParentMenuBar()->IsChecked(IDM_BOOT_TO_PAUSE)); const char* SettingName[] = {"Log", "LogConfig", "Console", "Registers", "Breakpoints", "Memory", "JIT", "Sound", "Video", "Code"}; // Save windows settings for (int i = IDM_LOG_WINDOW; i <= IDM_VIDEO_WINDOW; i++) ini.GetOrCreateSection("ShowOnStart") ->Set(SettingName[i - IDM_LOG_WINDOW], GetParentMenuBar()->IsChecked(i)); // Save notebook affiliations std::string section = "P - " + Parent->m_perspectives[Parent->m_active_perspective].name; for (int i = 0; i <= IDM_CODE_WINDOW - IDM_LOG_WINDOW; i++) ini.GetOrCreateSection(section)->Set(SettingName[i], iNbAffiliation[i]); // Save floating setting for (int i = IDM_LOG_WINDOW_PARENT; i <= IDM_CODE_WINDOW_PARENT; i++) ini.GetOrCreateSection("Float")->Set(SettingName[i - IDM_LOG_WINDOW_PARENT], !!FindWindowById(i)); ini.Save(File::GetUserPath(F_DEBUGGERCONFIG_IDX)); } void CCodeWindow::OnProfilerMenu(wxCommandEvent& event) { switch (event.GetId()) { case IDM_PROFILE_BLOCKS: Core::SetState(Core::State::Paused); JitInterface::ClearCache(); Profiler::g_ProfileBlocks = GetParentMenuBar()->IsChecked(IDM_PROFILE_BLOCKS); Core::SetState(Core::State::Running); break; case IDM_WRITE_PROFILE: if (Core::GetState() == Core::State::Running) Core::SetState(Core::State::Paused); if (Core::GetState() == Core::State::Paused && PowerPC::GetMode() == PowerPC::CoreMode::JIT) { std::string filename = File::GetUserPath(D_DUMP_IDX) + "Debug/profiler.txt"; File::CreateFullPath(filename); Profiler::WriteProfileResults(filename); wxFileType* filetype = nullptr; if (!(filetype = wxTheMimeTypesManager->GetFileTypeFromExtension("txt"))) { // From extension failed, trying with MIME type now if (!(filetype = wxTheMimeTypesManager->GetFileTypeFromMimeType("text/plain"))) // MIME type failed, aborting mission break; } wxString OpenCommand = filetype->GetOpenCommand(StrToWxStr(filename)); if (!OpenCommand.IsEmpty()) wxExecute(OpenCommand, wxEXEC_SYNC); } break; } } void CCodeWindow::OnSymbolsMenu(wxCommandEvent& event) { static const wxString signature_selector = _("Dolphin Signature File (*.dsy)") + "|*.dsy|" + _("Dolphin Signature CSV File (*.csv)") + "|*.csv|" + _("WiiTools Signature MEGA File (*.mega)") + "|*.mega|" + wxGetTranslation(wxALL_FILES); Parent->ClearStatusBar(); if (!Core::IsRunning()) return; std::string existing_map_file, writable_map_file, title_id_str; bool map_exists = CBoot::FindMapFile(&existing_map_file, &writable_map_file, &title_id_str); switch (event.GetId()) { case IDM_CLEAR_SYMBOLS: if (!AskYesNoT("Do you want to clear the list of symbol names?")) return; g_symbolDB.Clear(); Host_NotifyMapLoaded(); break; case IDM_SCAN_FUNCTIONS: PPCAnalyst::FindFunctions(0x80000000, 0x81800000, &g_symbolDB); // Update GUI NotifyMapLoaded(); break; case IDM_SCAN_SIGNATURES: { PPCAnalyst::FindFunctions(0x80000000, 0x81800000, &g_symbolDB); SignatureDB db(SignatureDB::HandlerType::DSY); if (db.Load(File::GetSysDirectory() + TOTALDB)) { db.Apply(&g_symbolDB); Parent->StatusBarMessage("Generated symbol names from '%s'", TOTALDB); db.List(); } else { Parent->StatusBarMessage("'%s' not found, no symbol names generated", TOTALDB); } // Update GUI NotifyMapLoaded(); break; } case IDM_SCAN_RSO: { wxTextEntryDialog dialog(this, _("Enter the RSO module address:")); if (dialog.ShowModal() == wxID_OK) { unsigned long address; if (dialog.GetValue().ToULong(&address, 0) && address <= std::numeric_limits::max()) { RSOChainView rso_chain; if (rso_chain.Load(static_cast(address))) { rso_chain.Apply(&g_symbolDB); // Update GUI NotifyMapLoaded(); } else { Parent->StatusBarMessage("Failed to load RSO module at %s", dialog.GetValue().ToStdString().c_str()); } } else { Parent->StatusBarMessage("Invalid RSO module address: %s", dialog.GetValue().ToStdString().c_str()); } } break; } case IDM_LOAD_MAP_FILE: if (!map_exists) { g_symbolDB.Clear(); PPCAnalyst::FindFunctions(0x81300000, 0x81800000, &g_symbolDB); SignatureDB db(SignatureDB::HandlerType::DSY); if (db.Load(File::GetSysDirectory() + TOTALDB)) db.Apply(&g_symbolDB); Parent->StatusBarMessage("'%s' not found, scanning for common functions instead", writable_map_file.c_str()); } else { g_symbolDB.LoadMap(existing_map_file); Parent->StatusBarMessage("Loaded symbols from '%s'", existing_map_file.c_str()); } HLE::PatchFunctions(); NotifyMapLoaded(); break; case IDM_LOAD_MAP_FILE_AS: { const wxString path = wxFileSelector( _("Load map file"), File::GetUserPath(D_MAPS_IDX), title_id_str + ".map", ".map", _("Dolphin Map File (*.map)") + "|*.map|" + wxGetTranslation(wxALL_FILES), wxFD_OPEN | wxFD_FILE_MUST_EXIST, this); if (!path.IsEmpty()) { g_symbolDB.LoadMap(WxStrToStr(path)); Parent->StatusBarMessage("Loaded symbols from '%s'", WxStrToStr(path).c_str()); } HLE::PatchFunctions(); NotifyMapLoaded(); } break; case IDM_LOAD_BAD_MAP_FILE: { const wxString path = wxFileSelector( _("Load bad map file"), File::GetUserPath(D_MAPS_IDX), title_id_str + ".map", ".map", _("Dolphin Map File (*.map)") + "|*.map|" + wxGetTranslation(wxALL_FILES), wxFD_OPEN | wxFD_FILE_MUST_EXIST, this); if (!path.IsEmpty()) { g_symbolDB.LoadMap(WxStrToStr(path), true); Parent->StatusBarMessage("Loaded symbols from '%s'", WxStrToStr(path).c_str()); } HLE::PatchFunctions(); NotifyMapLoaded(); } break; case IDM_SAVEMAPFILE: g_symbolDB.SaveSymbolMap(writable_map_file); break; case IDM_SAVE_MAP_FILE_AS: { const wxString path = wxFileSelector( _("Save map file as"), File::GetUserPath(D_MAPS_IDX), title_id_str + ".map", ".map", _("Dolphin Map File (*.map)") + "|*.map|" + wxGetTranslation(wxALL_FILES), wxFD_SAVE | wxFD_OVERWRITE_PROMPT, this); if (!path.IsEmpty()) g_symbolDB.SaveSymbolMap(WxStrToStr(path)); } break; case IDM_SAVE_MAP_FILE_WITH_CODES: { // Format the name for the codes version const std::string path = writable_map_file.substr(0, writable_map_file.find_last_of(".")) + "_code.map"; g_symbolDB.SaveCodeMap(path); } break; case IDM_RENAME_SYMBOLS: { const wxString path = wxFileSelector( _("Apply signature file"), wxEmptyString, wxEmptyString, wxEmptyString, _("Dolphin Symbol Rename File (*.sym)") + "|*.sym|" + wxGetTranslation(wxALL_FILES), wxFD_OPEN | wxFD_FILE_MUST_EXIST, this); if (!path.IsEmpty()) { std::ifstream f; OpenFStream(f, WxStrToStr(path), std::ios_base::in); std::string line; while (std::getline(f, line)) { if (line.length() < 12) continue; u32 address, type; std::string name; std::istringstream ss(line); ss >> std::hex >> address >> std::dec >> type >> name; Symbol* symbol = g_symbolDB.GetSymbolFromAddr(address); if (symbol) symbol->name = line.substr(12); } Host_NotifyMapLoaded(); } } break; case IDM_CREATE_SIGNATURE_FILE: { wxTextEntryDialog input_prefix(this, _("Only export symbols with prefix:\n(Blank for all symbols)"), wxGetTextFromUserPromptStr, wxEmptyString); if (input_prefix.ShowModal() == wxID_OK) { std::string prefix(WxStrToStr(input_prefix.GetValue())); wxString path = wxFileSelector(_("Save signature as"), File::GetSysDirectory(), wxEmptyString, wxEmptyString, signature_selector, wxFD_SAVE | wxFD_OVERWRITE_PROMPT, this); if (!path.IsEmpty()) { std::string save_path = WxStrToStr(path); SignatureDB db(save_path); db.Populate(&g_symbolDB, prefix); db.Save(save_path); db.List(); } } } break; case IDM_APPEND_SIGNATURE_FILE: { wxTextEntryDialog input_prefix(this, _("Only export symbols with prefix:\n(Blank for all symbols)"), wxGetTextFromUserPromptStr, wxEmptyString); if (input_prefix.ShowModal() == wxID_OK) { std::string prefix(WxStrToStr(input_prefix.GetValue())); wxString path = wxFileSelector(_("Append signature to"), File::GetSysDirectory(), wxEmptyString, wxEmptyString, signature_selector, wxFD_SAVE, this); if (!path.IsEmpty()) { std::string signature_path = WxStrToStr(path); SignatureDB db(signature_path); db.Populate(&g_symbolDB, prefix); db.List(); db.Load(signature_path); db.Save(signature_path); db.List(); } } } break; case IDM_USE_SIGNATURE_FILE: { wxString path = wxFileSelector(_("Apply signature file"), File::GetSysDirectory(), wxEmptyString, wxEmptyString, signature_selector, wxFD_OPEN | wxFD_FILE_MUST_EXIST, this); if (!path.IsEmpty()) { std::string load_path = WxStrToStr(path); SignatureDB db(load_path); db.Load(load_path); db.Apply(&g_symbolDB); db.List(); NotifyMapLoaded(); } } break; case IDM_COMBINE_SIGNATURE_FILES: { wxString path1 = wxFileSelector(_("Choose priority input file"), File::GetSysDirectory(), wxEmptyString, wxEmptyString, signature_selector, wxFD_OPEN | wxFD_FILE_MUST_EXIST, this); if (!path1.IsEmpty()) { std::string load_path1 = WxStrToStr(path1); SignatureDB db(load_path1); wxString path2 = wxFileSelector(_("Choose secondary input file"), File::GetSysDirectory(), wxEmptyString, wxEmptyString, signature_selector, wxFD_OPEN | wxFD_FILE_MUST_EXIST, this); if (!path2.IsEmpty()) { db.Load(load_path1); db.Load(WxStrToStr(path2)); path2 = wxFileSelector(_("Save combined output file as"), File::GetSysDirectory(), wxEmptyString, ".dsy", signature_selector, wxFD_SAVE | wxFD_OVERWRITE_PROMPT, this); db.Save(WxStrToStr(path2)); db.List(); } } } break; case IDM_PATCH_HLE_FUNCTIONS: HLE::PatchFunctions(); Repopulate(); break; } } void CCodeWindow::ReloadSymbolListBox() { symbols->Freeze(); // HyperIris: wx style fast filling symbols->Clear(); const wxString filtering_string = m_symbol_filter_ctrl->GetValue().Trim().Trim(false); for (const auto& symbol : g_symbolDB.Symbols()) { if (symbol.second.name.find(filtering_string) == std::string::npos) continue; int idx = symbols->Append(StrToWxStr(symbol.second.name)); symbols->SetClientData(idx, (void*)&symbol.second); } symbols->Thaw(); } void CCodeWindow::NotifyMapLoaded() { if (!codeview) return; g_symbolDB.FillInCallers(); ReloadSymbolListBox(); Repopulate(); } void CCodeWindow::OnSymbolListChange(wxCommandEvent& event) { int index = symbols->GetSelection(); if (index >= 0) { Symbol* pSymbol = static_cast(symbols->GetClientData(index)); if (pSymbol != nullptr) { if (pSymbol->type == Symbol::Type::Data) { CMemoryWindow* memory = GetPanel(); if (memory) memory->JumpToAddress(pSymbol->address); } else { JumpToAddress(pSymbol->address); } } } } // Change the global DebuggerFont void CCodeWindow::OnChangeFont(wxCommandEvent& event) { wxFontData data; data.SetInitialFont(DebuggerFont); wxFontDialog dialog(this, data); if (dialog.ShowModal() == wxID_OK) DebuggerFont = dialog.GetFontData().GetChosenFont(); UpdateFonts(); // TODO: Send event to all panels that tells them to reload the font when it changes. } // Toggle windows wxPanel* CCodeWindow::GetUntypedPanel(int id) const { wxASSERT_MSG(id >= IDM_DEBUG_WINDOW_LIST_START && id < IDM_DEBUG_WINDOW_LIST_END, "ID out of range"); wxASSERT_MSG(id != IDM_LOG_WINDOW && id != IDM_LOG_CONFIG_WINDOW, "Log windows are managed separately"); return m_sibling_panels.at(id - IDM_DEBUG_WINDOW_LIST_START); } void CCodeWindow::TogglePanel(int id, bool show) { wxPanel* panel = GetUntypedPanel(id); // Not all the panels (i.e. CodeWindow) have corresponding menu options. wxMenuItem* item = GetParentMenuBar()->FindItem(id); if (item) item->Check(show); if (show) { if (!panel) { panel = CreateSiblingPanel(id); } Parent->DoAddPage(panel, iNbAffiliation[id - IDM_DEBUG_WINDOW_LIST_START], Parent->m_float_window[id - IDM_DEBUG_WINDOW_LIST_START]); } else if (panel) // Close { Parent->DoRemovePage(panel, panel == this); m_sibling_panels[id - IDM_DEBUG_WINDOW_LIST_START] = nullptr; } } wxPanel* CCodeWindow::CreateSiblingPanel(int id) { // Includes range check inside the get call wxASSERT_MSG(!GetUntypedPanel(id), "Panel must not already exist"); wxPanel* panel = nullptr; switch (id) { // case IDM_LOG_WINDOW: // These exist separately in CFrame. // case IDM_LOG_CONFIG_WINDOW: case IDM_REGISTER_WINDOW: panel = new CRegisterWindow(Parent, IDM_REGISTER_WINDOW); break; case IDM_WATCH_WINDOW: panel = new CWatchWindow(Parent, IDM_WATCH_WINDOW); break; case IDM_BREAKPOINT_WINDOW: panel = new CBreakPointWindow(this, Parent, IDM_BREAKPOINT_WINDOW); break; case IDM_MEMORY_WINDOW: panel = new CMemoryWindow(Parent, IDM_MEMORY_WINDOW); break; case IDM_JIT_WINDOW: panel = new CJitWindow(Parent, IDM_JIT_WINDOW); break; case IDM_SOUND_WINDOW: panel = new DSPDebuggerLLE(Parent, IDM_SOUND_WINDOW); break; case IDM_VIDEO_WINDOW: panel = new GFXDebuggerPanel(Parent, IDM_VIDEO_WINDOW); break; case IDM_CODE_WINDOW: panel = this; break; default: wxTrap(); break; } m_sibling_panels[id - IDM_DEBUG_WINDOW_LIST_START] = panel; return panel; } void CCodeWindow::OpenPages() { // This is forced, and should always be placed as the first tab in the notebook. TogglePanel(IDM_CODE_WINDOW, true); // These panels are managed separately by CFrame if (bShowOnStart[IDM_LOG_WINDOW - IDM_DEBUG_WINDOW_LIST_START]) Parent->ToggleLogWindow(true); if (bShowOnStart[IDM_LOG_CONFIG_WINDOW - IDM_DEBUG_WINDOW_LIST_START]) Parent->ToggleLogConfigWindow(true); // Iterate normal panels that don't have weird rules. for (int i = IDM_REGISTER_WINDOW; i < IDM_CODE_WINDOW; ++i) { if (bShowOnStart[i - IDM_DEBUG_WINDOW_LIST_START]) TogglePanel(i, true); } }