Merge branch 'grumpycoders:main' into capstone

caldog20 · web-flow · commit 68dc6874edc4 · 2022-01-29T13:55:51.000-06:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,93 @@
+name: Report an issue with PCSX-Redux.
+description: Report an issue with PCSX-Redux.
+body:
+  - type: markdown
+    attributes:
+      value: |
+       This issue form is for reporting bugs only! If you have a feature or enhancement request, please make a proper feature request instead.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe the bug
+      description: >-
+        A clear and concise description of what the bug is.
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Expected behavior
+      description: >-
+        How the program should actually behave.
+  
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Steps to reproduce the bug
+      description: >-
+        Steps to reproduce the behavior
+      placeholder:
+        1. Go to '...'
+        
+        2. Click on '...'
+        
+        3. Press '...'
+
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Operating System
+      placeholder: (eg Windows 10, MacOS Big Sur, Ubuntu 20.04 LTS ...)
+      description: >
+        The OS of the system you're running Redux on
+
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: CPU model
+      placeholder: (eg Intel Core i7-7700K)
+      description: >
+        The CPU model of the system you're running PCSX-Redux on
+
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: GPU model
+      placeholder: (eg Nvidia GeForce GTX 980 Ti)
+      description: >
+        The GPU model of the system you're running PCSX-Redux on
+        
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: BIOS version
+      placeholder: (eg OpenBIOS, SCPH1001, etc)
+      description: >
+        The BIOS you're using to play games.
+
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: CPU emulation mode
+      description: >
+        If the menu bar says "Interpreted" on the top right, pick "Interpreter". Otherwise, pick "Recompiler"
+      options:
+        - Interpreter
+        - Recompiler
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Additional information
+      description: >-
+        If you have any additional information for us, use the field below. Feel free to share your memory card if you think it'd help us reproduce and debug your problem.
+        
+        For bugs where a screenshot or video would be useful (eg rendering or audio bugs), please attach one as well.
diff --git a/Makefile b/Makefile
@@ -10,6 +10,12 @@ PACKAGES := capstone freetype2 glfw3 libavcodec libavformat libavutil libswresam
 
 LOCALES := fr
 
+ifeq ($(wildcard third_party/imgui/imgui.h),)
+HAS_SUBMODULES = false
+else
+HAS_SUBMODULES = true
+endif
+
 CXXFLAGS += -std=c++2a
 CPPFLAGS += `pkg-config --cflags $(PACKAGES)`
 CPPFLAGS += -I.
@@ -124,7 +130,16 @@ TESTS := $(patsubst %.cc,%,$(TESTS_SRC))
 CP ?= cp
 MKDIRP ?= mkdir -p
 
-all: dep $(TARGET)
+all: check_submodules dep $(TARGET)
+
+ifeq ($(HAS_SUBMODULES),true)
+check_submodules:
+
+else
+check_submodules:
+	@echo "You need to clone this repository recursively, in order to get its submodules."
+	@false
+endif
 
 strip: all
 	strip $(TARGET)
@@ -213,7 +228,7 @@ runtests: pcsx-redux-tests
 	./pcsx-redux-tests
 
 psyq-obj-parser: $(SUPPORT_OBJECTS) tools/psyq-obj-parser/psyq-obj-parser.cc
-	$(LD) -o $@ $(SUPPORT_OBJECTS) $(CPPFLAGS) $(CXXFLAGS) $(LDFLAGS) tools/psyq-obj-parser/psyq-obj-parser.cc -Ithird_party/ELFIO
+	$(LD) -o $@ $(SUPPORT_OBJECTS) $(CPPFLAGS) $(CXXFLAGS) tools/psyq-obj-parser/psyq-obj-parser.cc -Ithird_party/ELFIO
 
 ps1-packer: $(SUPPORT_OBJECTS) tools/ps1-packer/ps1-packer.cc
 	$(LD) -o $@ $(SUPPORT_OBJECTS) $(CPPFLAGS) $(CXXFLAGS) $(LDFLAGS) tools/ps1-packer/ps1-packer.cc
@@ -229,7 +244,9 @@ dep: $(DEPS)
 ifneq ($(MAKECMDGOALS), regen-i18n)
 ifneq ($(MAKECMDGOALS), clean)
 ifneq ($(MAKECMDGOALS), gitclean)
+ifeq ($(HAS_SUBMODULES), true)
 -include $(DEPS)
 endif
 endif
 endif
+endif
diff --git a/README.md b/README.md
@@ -32,7 +32,11 @@ This is yet another fork of the Playstation Emulator, PCSX. While the work here
 The code is meant to be built using very modern compilers. Also it's still fairly experimental, and lots of things can break. If you still want to proceed, here are instructions to build it on Linux, MacOS and Windows. The code now comes in two big parts: the emulator itself, and [OpenBIOS](https://github.com/grumpycoders/pcsx-redux/tree/main/src/mips/openbios), which can be used as an alternative to the retail, copyright protected BIOS.
 
 ### Getting sources
-The only location for the source is [on github](https://github.com/grumpycoders/pcsx-redux/). Clone recursively, as the project uses submodules: `git clone https://github.com/grumpycoders/pcsx-redux.git --recursive`.
+The only location for the source is [on github](https://github.com/grumpycoders/pcsx-redux/).
+Clone recursively, as the project uses submodules:
+```
+git clone --recursive https://github.com/grumpycoders/pcsx-redux.git
+```
 
 ### Windows
 Install [Visual Studio 2022 Community Edition](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=16) using the `Desktop development with C++` workload. Open the file `vsprojects\pcsx-redux.sln`, select `pcsx-redux -> pcsx-redux`, right click, `Set as Startup Project`, and hit `F7` to build. The project follows the open-and-build paradigm with no extra step, so no specific dependency ought to be needed, as [NuGet](https://www.nuget.org/) will take care of downloading them automatically for you on the first build.
diff --git a/src/core/DynaRec_x64/instructions.cc b/src/core/DynaRec_x64/instructions.cc
@@ -1343,13 +1343,13 @@ void DynaRecCPU::testSoftwareInterrupt() {
     if constexpr (loadSR) {
         gen.mov(eax, dword[contextPointer + COP0_OFFSET(12)]);  // eax = SR
     }
-    gen.test(eax, 1);                                 // Check if interrupts are enabled
-    gen.jz(label, CodeGenerator::LabelType::T_NEAR);  // If not, skip to the end
+    gen.test(eax, 1);  // Check if interrupts are enabled
+    gen.jz(label);     // If not, skip to the end
 
     gen.mov(arg2, dword[contextPointer + COP0_OFFSET(13)]);  // arg2 = CAUSE
     gen.and_(eax, arg2);
-    gen.test(eax, 0x300);                             // Check if an interrupt was force-fired
-    gen.jz(label, CodeGenerator::LabelType::T_NEAR);  // Skip to the end if not
+    gen.test(eax, 0x300);  // Check if an interrupt was force-fired
+    gen.jz(label);         // Skip to the end if not
 
     // Fire the interrupt if it was triggered
     // This object in arg1. Exception code is already in arg2 from before (will be masked by exception handler)
@@ -1602,7 +1602,6 @@ void DynaRecCPU::recBLEZ() {
     gen.mov(dword[contextPointer + PC_OFFSET], eax);
 }
 
-// TODO: Handle INT_MIN / -1
 void DynaRecCPU::recDIV() {
     Label notIntMin, divisionByZero, end;
     bool emitIntMinCheck = true;
@@ -1655,9 +1654,9 @@ void DynaRecCPU::recDIV() {
             gen.mov(eax, m_regs[_Rs_].allocatedReg);  // Dividend in eax
         }
 
-        gen.mov(ecx, m_regs[_Rt_].allocatedReg);                   // Divisor in ecx
-        gen.test(ecx, ecx);                                        // Check if divisor is 0
-        gen.jz(divisionByZero, CodeGenerator::LabelType::T_NEAR);  // Jump to divisionByZero label if so
+        gen.mov(ecx, m_regs[_Rt_].allocatedReg);  // Divisor in ecx
+        gen.test(ecx, ecx);                       // Check if divisor is 0
+        gen.jz(divisionByZero);                   // Jump to divisionByZero label if so
     }
 
     if (emitIntMinCheck) {
@@ -1677,8 +1676,8 @@ void DynaRecCPU::recDIV() {
     gen.idiv(ecx);  // Signed division by divisor
 
     if (!m_regs[_Rt_].isConst()) {  // Emit a division by 0 handler if the divisor is unknown at compile time
-        gen.jmp(end, CodeGenerator::LabelType::T_NEAR);  // skip to the end if not a div by zero
-        gen.L(divisionByZero);                           // Here starts our division by 0 handler
+        gen.jmp(end);               // skip to the end if not a div by zero
+        gen.L(divisionByZero);      // Here starts our division by 0 handler
 
         gen.mov(edx, eax);  // Set hi to $rs
         gen.shr(eax, 31);
@@ -1730,18 +1729,18 @@ void DynaRecCPU::recDIVU() {
             gen.mov(eax, m_regs[_Rs_].allocatedReg);  // Dividend in eax
         }
 
-        gen.mov(ecx, m_regs[_Rt_].allocatedReg);                   // Divisor in ecx
-        gen.test(ecx, ecx);                                        // Check if divisor is 0
-        gen.jz(divisionByZero, CodeGenerator::LabelType::T_NEAR);  // Jump to divisionByZero label if so
+        gen.mov(ecx, m_regs[_Rt_].allocatedReg);  // Divisor in ecx
+        gen.test(ecx, ecx);                       // Check if divisor is 0
+        gen.jz(divisionByZero);                   // Jump to divisionByZero label if so
     }
 
-    gen.xor_(edx, edx);  // Set top 32 bits of dividend to
+    gen.xor_(edx, edx);  // Set top 32 bits of dividend to 0
     gen.div(ecx);        // Unsigned division by divisor
 
     if (!m_regs[_Rt_].isConst()) {  // Emit a division by 0 handler if the divisor is unknown at compile time
         Label end;
-        gen.jmp(end, CodeGenerator::LabelType::T_NEAR);  // skip to the end if not a div by zero
-        gen.L(divisionByZero);                           // Here starts our division by 0 handler
+        gen.jmp(end);           // skip to the end if not a div by zero
+        gen.L(divisionByZero);  // Here starts our division by 0 handler
 
         gen.mov(edx, eax);  // Set hi to $rs
         gen.mov(eax, -1);   // Set lo to -1
diff --git a/src/core/ix86/iR3000A.cc b/src/core/ix86/iR3000A.cc
@@ -2864,14 +2864,14 @@ const func_t DynaRecCPU::m_recSPC[64] = {
 };
 
 const func_t DynaRecCPU::m_recREG[32] = {
-    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 00
-    &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 04
-    &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 08
-    &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 0c
-    &DynaRecCPU::recBLTZAL, &DynaRecCPU::recBGEZAL, &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 10
-    &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 14
-    &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 18
-    &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL,   &DynaRecCPU::recNULL, &DynaRecCPU::recNULL,  // 1c
+    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ, // 00
+    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ, // 04
+    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ, // 08
+    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ, // 0c
+    &DynaRecCPU::recBLTZAL, &DynaRecCPU::recBGEZAL, &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ, // 10
+    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ, // 14
+    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ, // 18
+    &DynaRecCPU::recBLTZ,   &DynaRecCPU::recBGEZ,   &DynaRecCPU::recBLTZ, &DynaRecCPU::recBGEZ  // 1c
 };
 
 const func_t DynaRecCPU::m_recCP0[32] = {
diff --git a/src/core/psxemulator.h b/src/core/psxemulator.h
@@ -184,11 +184,13 @@ class Emulator {
     typedef Setting<bool, TYPESTRING("8Megs"), false> Setting8MB;
     typedef Setting<int, TYPESTRING("GUITheme"), 0> SettingGUITheme;
     typedef Setting<int, TYPESTRING("Dither"), 2> SettingDither;
+    typedef Setting<bool, TYPESTRING("ReportGLErrors"), false> SettingGLErrorReporting;
 
     Settings<SettingStdout, SettingLogfile, SettingMcd1, SettingMcd2, SettingBios, SettingPpfDir, SettingPsxExe,
              SettingXa, SettingSpuIrq, SettingBnWMdec, SettingScaler, SettingAutoVideo, SettingVideo, SettingCDDA,
              SettingFastBoot, SettingDebugSettings, SettingRCntFix, SettingIsoPath, SettingLocale, SettingMcd1Inserted,
-             SettingMcd2Inserted, SettingBiosOverlay, SettingDynarec, Setting8MB, SettingGUITheme, SettingDither>
+             SettingMcd2Inserted, SettingBiosOverlay, SettingDynarec, Setting8MB, SettingGUITheme, SettingDither,
+             SettingGLErrorReporting>
         settings;
     class PcsxConfig {
       public:
diff --git a/src/core/psxinterpreter.cc b/src/core/psxinterpreter.cc
@@ -1190,15 +1190,18 @@ const InterpretedCPU::intFunc_t InterpretedCPU::s_psxSPC[64] = {
     &InterpretedCPU::psxNULL,    &InterpretedCPU::psxNULL,  &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 3c
 };
 
+// The REGIMM instruction is actually valid for every single value that the rt field might have
+// If the lowest bit of the rt field is 1 then the instruction is a BGEZ, otherwise it's a BLTZ.
+// If ((_Rt_ >> 4) & 0xF) == 0x8 then the instruction should link the return address to $ra, otherwise not.
 const InterpretedCPU::intFunc_t InterpretedCPU::s_psxREG[32] = {
-    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 00
-    &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 04
-    &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 08
-    &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 0c
-    &InterpretedCPU::psxBLTZAL, &InterpretedCPU::psxBGEZAL, &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 10
-    &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 14
-    &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 18
-    &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL,   &InterpretedCPU::psxNULL, &InterpretedCPU::psxNULL,  // 1c
+    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ, // 00
+    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ, // 04
+    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ, // 08
+    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ, // 0c
+    &InterpretedCPU::psxBLTZAL, &InterpretedCPU::psxBGEZAL, &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ, // 10
+    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ, // 14
+    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ, // 18
+    &InterpretedCPU::psxBLTZ,   &InterpretedCPU::psxBGEZ,   &InterpretedCPU::psxBLTZ, &InterpretedCPU::psxBGEZ  // 1c
 };
 
 const InterpretedCPU::intFunc_t InterpretedCPU::s_psxCP0[32] = {
diff --git a/src/gui/gui.cc b/src/gui/gui.cc
@@ -345,7 +345,7 @@ end)(jit.status()))
 
         setFullscreen(m_fullscreen);
         const auto currentTheme =
-            g_emulator->settings.get<Emulator::SettingGUITheme>().value;  // On boot: reload GUI theme
+            emuSettings.get<Emulator::SettingGUITheme>().value;  // On boot: reload GUI theme
         applyTheme(currentTheme);
 
         if (emuSettings.get<Emulator::SettingMcd1>().empty()) {
@@ -409,8 +409,10 @@ end)(jit.status()))
     glfwSetKeyCallback(m_window, glfwKeyCallbackTrampoline);
     glfwSetJoystickCallback([](int jid, int event) { PCSX::g_emulator->m_pads->scanGamepads(); });
     ImGui_ImplOpenGL3_Init(GL_SHADER_VERSION);
-    glEnable(GL_DEBUG_OUTPUT);
-    if (glDebugMessageCallback) {
+
+    if (glDebugMessageCallback && g_emulator->settings.get<Emulator::SettingGLErrorReporting>()) {
+        m_reportGLErrors = true;
+        glEnable(GL_DEBUG_OUTPUT);
         glDebugMessageCallback(
             [](GLenum source, GLenum type, GLuint id, GLenum severity, GLsizei length, const GLchar* message,
                GLvoid* userParam) {
@@ -1088,7 +1090,7 @@ in Configuration->Emulation, restart PCSX-Redux, then try again.)"));
         m_breakpoints.draw(_("Breakpoints"));
     }
 
-    about();
+    changed |= about();
     interruptsScaler();
 
     if (m_dwarf.m_show) {
@@ -1520,8 +1522,10 @@ bool PCSX::GUI::showThemes() {
     return changed;
 }
 
-void PCSX::GUI::about() {
-    if (!m_showAbout) return;
+bool PCSX::GUI::about() {
+    if (!m_showAbout) return false;
+    bool changed = false;
+
     ImGui::SetNextWindowPos(ImVec2(200, 100), ImGuiCond_FirstUseEver);
     ImGui::SetNextWindowSize(ImVec2(880, 600), ImGuiCond_FirstUseEver);
     if (ImGui::Begin(_("About"), &m_showAbout)) {
@@ -1541,16 +1545,28 @@ void PCSX::GUI::about() {
                 ImGui::EndTabItem();
             }
             if (ImGui::BeginTabItem(_("OpenGL information"))) {
-                if (glDebugMessageCallback) {
+                if (m_reportGLErrors) {
                     ImGui::TextUnformatted(_("OpenGL error reporting: enabled"));
                 } else {
                     ImGui::TextUnformatted(_("OpenGL error reporting: disabled"));
-                    ShowHelpMarker(
-                        _("OpenGL error reporting has been disabled because your OpenGL driver is too old. Error "
-                          "reporting requires at least OpenGL 4.3. Please update your graphics drivers, or contact "
-                          "your GPU vendor for correct OpenGL drivers. Disabled OpenGL error reporting won't have a "
-                          "negative impact on the performances of this software, but user code such as the shader "
-                          "editor won't be able to properly report problems accurately."));
+                    if (!glDebugMessageCallback) {
+                        ShowHelpMarker(_(
+                            "OpenGL error reporting has been disabled because your OpenGL driver is too old. Error "
+                            "reporting requires at least OpenGL 4.3. Please update your graphics drivers, or contact "
+                            "your GPU vendor for correct OpenGL drivers. Disabled OpenGL error reporting won't have a "
+                            "negative impact on the performances of this software, but user code such as the shader "
+                            "editor won't be able to properly report problems accurately."));
+                    }
+                }
+
+                if (glDebugMessageCallback) {
+                    changed |= ImGui::Checkbox(_("Enable OpenGL error reporting"),
+                                               &g_emulator->settings.get<Emulator::SettingGLErrorReporting>().value);
+                    
+                    ShowHelpMarker(_(
+                            "OpenGL error reporting is necessary for properly reporting OpenGL problems. "
+                            "However it requires OpenGL 4.3+ and might have performance repercussions on "
+                            "some PCs. (Requires reboot)"));
                 }
                 ImGui::Text(_("Core profile: %s"), m_hasCoreProfile ? "yes" : "no");
                 someString(_("Vendor"), GL_VENDOR);
@@ -1572,6 +1588,7 @@ void PCSX::GUI::about() {
         }
     }
     ImGui::End();
+    return changed;
 }
 
 void PCSX::GUI::update(bool vsync) {
diff --git a/src/gui/gui.h b/src/gui/gui.h
diff --git a/src/mips/common/psxlibc/fastmemset.s b/src/mips/common/psxlibc/fastmemset.s
