Configured the garbage collector for lower spikes (#88)

Did you know that the garbage collector's default settings are designed for single-threaded applications and quick start-up times? We don't care about either of these.

Configured:
- Concurrent GC (default is true) (set for clarity)
- RetainVM: segments that should be deleted are put on a standby list for future use (default is false)
- QuickJit: enabling quick JIT decreases startup time but can produce code with degraded performance characteristics; for example, the code may use more stack space, allocate more memory, and run slower. (default is true) (disabled)
- ReadyToRun: configures whether the .NET runtime uses pre-compiled code for images with available ReadyToRun data; disabling this option forces the runtime to JIT-compile framework code. (default is true) (set to false, we dont publish with this option anyway)
- TieredPGO: this setting enables dynamic (tiered) profile-guided optimization (PGO) in .NET 6 and later versions. If quick JIT is disabled but tiered compilation is enabled, only pre-compiled code participates in tiered compilation. If a method is not pre-compiled with ReadyToRun, the JIT behavior is the same as if tiered compilation were disabled.

Features:
- Set ``GCLatencyMode.Interactive`` when in-menu and emulator is paused, otherwise uses ``GCLatencyMode.LowLatency``.
- Added a new UI option in the Settings > CPU menu to toggle ``GCLatencyMode.LowLatency`` during guest runtime.

![image](/attachments/84ffc6c6-d92c-4ec5-8a95-9d72dc6f1b04)

Reviewed-on: https://git.ryujinx.app/projects/Ryubing/pulls/88

.forgejo/workflows/build.yml

@@ -28,7 +28,7 @@ jobs:
         configuration: [Release]
         platform:
           - { name: win-x64,     zip_os_name: win_x64     }
-          #- { name: win-arm64,   zip_os_name: win_arm64   }
+          - { name: win-arm64,   zip_os_name: win_arm64   }
           - { name: linux-x64,   zip_os_name: linux_x64   }
           - { name: linux-arm64, zip_os_name: linux_arm64 }
           #- { name: osx-x64,     zip_os_name: osx_x64     }

.forgejo/workflows/canary.yml

@@ -32,9 +32,9 @@ jobs:
       matrix:
         platform:
           - { name: win-x64,     os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: win_x64     }
-          #- { name: win-arm64,   os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: win_arm64   }
+          - { name: win-arm64,   os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: win_arm64   }
-          - { name: linux-x64,   os: ghcr.io/catthehacker/ubuntu:act-latest,  zip_os_name: linux_x64   }
+          - { name: linux-x64,   os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: linux_x64   }
-          - { name: linux-arm64, os: ghcr.io/catthehacker/ubuntu:act-latest,  zip_os_name: linux_arm64 }
+          - { name: linux-arm64, os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: linux_arm64 }
     steps:
       - uses: actions/checkout@v6
 

.forgejo/workflows/release.yml

@@ -26,9 +26,9 @@ jobs:
       matrix:
         platform:
           - { name: win-x64,     os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: win_x64     }
-          #- { name: win-arm64,   os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: win_arm64   }
+          - { name: win-arm64,   os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: win_arm64   }
-          - { name: linux-x64,   os: ghcr.io/catthehacker/ubuntu:act-latest,  zip_os_name: linux_x64   }
+          - { name: linux-x64,   os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: linux_x64   }
-          - { name: linux-arm64, os: ghcr.io/catthehacker/ubuntu:act-latest,  zip_os_name: linux_arm64 }
+          - { name: linux-arm64, os: ghcr.io/catthehacker/ubuntu:act-latest, zip_os_name: linux_arm64 }
     steps:
       - uses: actions/checkout@v6
 

assets/Locales/Root.json

@@ -200,6 +200,31 @@
         "zh_TW": "使用 Hypervisor"
       }
     },
+    {
+      "ID": "SettingsTabSystemGCLowLatency",
+      "Translations": {
+        "ar_SA": "",
+        "de_DE": "",
+        "el_GR": "",
+        "en_US": "Use Low-latency Garbage Collector",
+        "es_ES": "Usa recolección de basura de baja latencia",
+        "fr_FR": "",
+        "he_IL": "",
+        "it_IT": "",
+        "ja_JP": "",
+        "ko_KR": "",
+        "no_NO": "",
+        "pl_PL": "",
+        "pt_BR": "",
+        "ru_RU": "",
+        "sv_SE": "",
+        "th_TH": "",
+        "tr_TR": "",
+        "uk_UA": "",
+        "zh_CN": "",
+        "zh_TW": ""
+      }
+    },
     {
       "ID": "MenuBarFile",
       "Translations": {
@@ -16550,6 +16575,31 @@
         "zh_TW": "變更客體記憶體的映射和存取方式。這會極大地影響模擬 CPU 效能。\n\n如果不確定，請設定為主體略過檢查模式。"
       }
     },
+    {
+      "ID": "GCLowLatencyTooltip",
+      "Translations": {
+        "ar_SA": "",
+        "de_DE": "",
+        "el_GR": "",
+        "en_US": "Sets the garbage collector for the CLR to low-latency mode.\n\nThis may decrease stuttering at the cost of performance.\n\nLeave OFF if unsure.",
+        "es_ES": "",
+        "fr_FR": "",
+        "he_IL": "",
+        "it_IT": "",
+        "ja_JP": "",
+        "ko_KR": "",
+        "no_NO": "",
+        "pl_PL": "",
+        "pt_BR": "",
+        "ru_RU": "",
+        "sv_SE": "",
+        "th_TH": "",
+        "tr_TR": "",
+        "uk_UA": "",
+        "zh_CN": "",
+        "zh_TW": ""
+      }
+    },
     {
       "ID": "MemoryManagerSoftwareTooltip",
       "Translations": {

src/Ryujinx.HLE/HOS/Services/Caps/CaptureManager.cs

@@ -133,9 +133,9 @@ namespace Ryujinx.HLE.HOS.Services.Caps
 
             using SKBitmap bitmap = new(new SKImageInfo(ScreenshotWidth, ScreenshotHeight, SKColorType.Rgba8888));
 
-            IntPtr pixels = bitmap.GetPixels();
+            nint pixels = bitmap.GetPixels();
 
-            if (pixels == IntPtr.Zero)
+            if (pixels == 0)
             {
                 return ResultCode.InvalidArgument;
             }

src/Ryujinx/Program.cs

@@ -198,6 +198,12 @@ namespace Ryujinx.Ava
         public static AppBuilder BuildAvaloniaApp() =>
             AppBuilder.Configure<RyujinxApp>()
                 .UsePlatformDetect()
+                
+                // Vulkan UI rendering performs better, but its unpolished, and as such it lacks effective transparency.
+                // https://github.com/AvaloniaUI/Avalonia/issues/19378
+                // https://github.com/AvaloniaUI/Avalonia/issues/9610
+                // X11RenderingMode.Glx && X11RenderingMode.Egl, Win32RenderingMode.Vulkan have these issues.
+                
                 .With(new X11PlatformOptions
                 {
                     EnableMultiTouch = true,

src/Ryujinx/Systems/AppHost.cs

@@ -46,6 +46,7 @@ using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Runtime;
 using System.Runtime.InteropServices;
 using System.Threading;
 using System.Threading.Tasks;
@@ -579,6 +580,12 @@ namespace Ryujinx.Ava.Systems
         {
             _isActive = false;
             _playTimer.Stop();
+            
+            GCSettings.LatencyMode = GCLatencyMode.Interactive;
+            if (ConfigurationState.Instance.System.GCLowLatency)
+            {
+                Logger.Info?.Print(LogClass.Application, "Garbage collector set to interactive mode.");
+            }
         }
 
         private void Exit()
@@ -662,6 +669,12 @@ namespace Ryujinx.Ava.Systems
 
             _chrono.Stop();
             _playTimer.Stop();
+            
+            GCSettings.LatencyMode = GCLatencyMode.Interactive;
+            if (ConfigurationState.Instance.System.GCLowLatency)
+            {
+                Logger.Info?.Print(LogClass.Application, "Garbage collector set to interactive mode.");
+            }
         }
 
         public void DisposeGpu()
@@ -915,7 +928,14 @@ namespace Ryujinx.Ava.Systems
             ApplicationLibrary.LoadAndSaveMetaData(Device.Processes.ActiveApplication.ProgramIdText,
                 appMetadata => appMetadata.UpdatePreGame()
             );
+            
             _playTimer.Start();
+
+            if (ConfigurationState.Instance.System.GCLowLatency)
+            {
+                GCSettings.LatencyMode = GCLatencyMode.LowLatency;
+                Logger.Info?.Print(LogClass.Application, "Garbage collector set to low latency mode.");
+            }
         }
 
         internal void Resume()
@@ -926,6 +946,12 @@ namespace Ryujinx.Ava.Systems
             _playTimer.Start();
             _viewModel.Title = TitleHelper.ActiveApplicationTitle(Device?.Processes.ActiveApplication, Program.Version, !ConfigurationState.Instance.ShowOldUI);
             Logger.Info?.Print(LogClass.Emulation, "Emulation was resumed.");
+            
+            if (ConfigurationState.Instance.System.GCLowLatency)
+            {
+                GCSettings.LatencyMode = GCLatencyMode.LowLatency;
+                Logger.Info?.Print(LogClass.Application, "Garbage collector set to low latency mode.");
+            }
         }
 
         internal void Pause()
@@ -936,6 +962,12 @@ namespace Ryujinx.Ava.Systems
             _playTimer.Stop();
             _viewModel.Title = TitleHelper.ActiveApplicationTitle(Device?.Processes.ActiveApplication, Program.Version, !ConfigurationState.Instance.ShowOldUI, LocaleManager.Instance[LocaleKeys.Paused]);
             Logger.Info?.Print(LogClass.Emulation, "Emulation was paused.");
+            
+            GCSettings.LatencyMode = GCLatencyMode.Interactive;
+            if (ConfigurationState.Instance.System.GCLowLatency)
+            {
+                Logger.Info?.Print(LogClass.Application, "Garbage collector set to interactive mode.");
+            }
         }
 
         private void InitEmulatedSwitch()

src/Ryujinx/Systems/Configuration/ConfigurationFileFormat.cs

@@ -471,6 +471,11 @@ namespace Ryujinx.Ava.Systems.Configuration
         /// </summary>
         public bool UseHypervisor { get; set; }
         
+        /// <summary>
+        /// Enable or disable low-latency mode for garbage collection
+        /// </summary>
+        public bool GCLowLatency { get; set; }
+
         /// <summary>
         /// Enables or disables the GDB stub
         /// </summary>

src/Ryujinx/Systems/Configuration/ConfigurationState.Migration.cs

@@ -112,6 +112,7 @@ namespace Ryujinx.Ava.Systems.Configuration
             System.IgnoreControllerApplet.Value = cff.IgnoreApplet;
             System.SkipUserProfilesManager.Value = cff.SkipUserProfiles;
             System.UseHypervisor.Value = cff.UseHypervisor;
+            System.GCLowLatency.Value = cff.GCLowLatency;
 
             UI.GuiColumns.FavColumn.Value = shouldLoadFromFile ? cff.GuiColumns.FavColumn : UI.GuiColumns.FavColumn.Value;
             UI.GuiColumns.IconColumn.Value = shouldLoadFromFile ? cff.GuiColumns.IconColumn : UI.GuiColumns.IconColumn.Value;
@@ -535,7 +536,8 @@ namespace Ryujinx.Ava.Systems.Configuration
                 {
                     if (cff.AudioBackend is AudioBackend.SDL2)
                         cff.AudioBackend = AudioBackend.SDL3;
-                })
+                }),
+                (72, static cff => cff.GCLowLatency = false)
             );
     }
 }

src/Ryujinx/Systems/Configuration/ConfigurationState.Model.cs

@@ -418,6 +418,11 @@ namespace Ryujinx.Ava.Systems.Configuration
             /// </summary>
             public ReactiveObject<bool> UseHypervisor { get; private set; }
             
+            /// <summary>
+            /// Enable or disable low-latency garbage collection
+            /// </summary>
+            public ReactiveObject<bool> GCLowLatency { get; private set; }
+
             public SystemSection()
             {
                 Language = new ReactiveObject<Language>();
@@ -471,6 +476,8 @@ namespace Ryujinx.Ava.Systems.Configuration
                 AudioVolume.LogChangesToValue(nameof(AudioVolume));
                 UseHypervisor = new ReactiveObject<bool>();
                 UseHypervisor.LogChangesToValue(nameof(UseHypervisor));
+                GCLowLatency = new ReactiveObject<bool>();
+                GCLowLatency.LogChangesToValue(nameof(GCLowLatency));
             }
         }
 

src/Ryujinx/Systems/Configuration/ConfigurationState.cs

@@ -87,6 +87,7 @@ namespace Ryujinx.Ava.Systems.Configuration
                 IgnoreApplet = System.IgnoreControllerApplet,
                 SkipUserProfiles = System.SkipUserProfilesManager,
                 UseHypervisor = System.UseHypervisor,
+                GCLowLatency = System.GCLowLatency,
                 GuiColumns = new GuiColumns
                 {
                     FavColumn = UI.GuiColumns.FavColumn,

src/Ryujinx/UI/ViewModels/MainWindowViewModel.cs

@@ -2067,6 +2067,7 @@ namespace Ryujinx.Ava.UI.ViewModels
             Win32NativeInterop.SetWindowLongPtrW(hwnd, Win32NativeInterop.GWL_STYLE,
                 unchecked((nint)(Win32NativeInterop.WS_POPUP | Win32NativeInterop.WS_VISIBLE)));
             
+            // TODO: why is this nullable
             Avalonia.Platform.Screen? screen = Window.Screens.ScreenFromVisual(Window);
             int w = screen?.Bounds.Width ?? 0;
             int h = screen?.Bounds.Height ?? 0;

src/Ryujinx/UI/ViewModels/SettingsViewModel.cs

@@ -286,6 +286,7 @@ namespace Ryujinx.Ava.UI.ViewModels
         public bool IsVulkanSelected =>
             GraphicsBackendIndex == 1 || (GraphicsBackendIndex == 0 && !OperatingSystem.IsMacOS());
         public bool UseHypervisor { get; set; }
+        public bool GCLowLatency { get; set; }
         public bool DisableP2P { get; set; }
 
         public bool ShowDirtyHacks => ConfigurationState.Instance.Hacks.ShowDirtyHacks;
@@ -689,6 +690,7 @@ namespace Ryujinx.Ava.UI.ViewModels
             EnableLowPowerPptc = config.System.EnableLowPowerPtc;
             MemoryMode = (int)config.System.MemoryManagerMode.Value;
             UseHypervisor = config.System.UseHypervisor;
+            GCLowLatency = config.System.GCLowLatency;
             TurboMultiplier = config.System.TickScalar;
 
             // Graphics
@@ -800,6 +802,7 @@ namespace Ryujinx.Ava.UI.ViewModels
             config.System.EnableLowPowerPtc.Value = EnableLowPowerPptc;
             config.System.MemoryManagerMode.Value = (MemoryManagerMode)MemoryMode;
             config.System.UseHypervisor.Value = UseHypervisor;
+            config.System.GCLowLatency.Value = GCLowLatency;
             config.System.TickScalar.Value = TurboMultiplier;
 
             // Graphics

src/Ryujinx/UI/Views/Settings/SettingsCPUView.axaml

@@ -71,6 +71,11 @@
                         <TextBlock Text="{ext:Locale SettingsTabSystemUseHypervisor}"
                                    ToolTip.Tip="{ext:Locale UseHypervisorTooltip}" />
                     </CheckBox>
+                    <CheckBox
+                        IsChecked="{Binding GCLowLatency}"
+                        ToolTip.Tip="{ext:Locale GCLowLatencyTooltip}">
+                        <TextBlock Text="{ext:Locale SettingsTabSystemGCLowLatency}" />
+                    </CheckBox>
                 </StackPanel>
                 <Separator Height="1" />
                 <StackPanel

src/Ryujinx/runtimeconfig.template.json

@@ -0,0 +1,11 @@
+{
+  "configProperties": {
+    "System.GC.Concurrent": true,
+    "System.GC.Server": false,
+    "System.GC.RetainVM": true,
+    "System.Runtime.TieredCompilation.QuickJit": false,
+    "System.Runtime.TieredCompilation.QuickJitForLoops": false,
+    "DOTNET_ReadyToRun": false,
+    "DOTNET_TieredPGO": true
+  }
+}