Linux: Automatically increase vm.max_map_count if it's too low (#4702)

* memory: Check results of pinvoke calls

* Increase vm.max_map_count when running Ryujinx

* Add SupportedOSPlatform attribute for WindowsApiException

* Revert increasing vm.max_map_count via script

* Add LinuxHelper to detect and increase vm.max_map_count

With GUI dialogs, this should be a bit more user-friendly.

* Supply arguments as a list to RunPkExec

* Add error logging in case RunPkExec() fails

* Prevent Gtk from crashing

distribution/linux/Ryujinx.sh

@@ -17,4 +17,4 @@ if command -v gamemoderun > /dev/null 2>&1; then
     COMMAND="$COMMAND gamemoderun"
 fi
 
-$COMMAND "$SCRIPT_DIR/$RYUJINX_BIN" "$@"
+$COMMAND "$SCRIPT_DIR/$RYUJINX_BIN" "$@"

src/Ryujinx.Ava/Assets/Locales/en_US.json

@@ -74,6 +74,13 @@
   "GameListContextMenuExtractDataLogoToolTip": "Extract the Logo section from Application's current config (including updates)",
   "StatusBarGamesLoaded": "{0}/{1} Games Loaded",
   "StatusBarSystemVersion": "System Version: {0}",
+  "LinuxVmMaxMapCountDialogTitle": "Low limit for memory mappings detected",
+  "LinuxVmMaxMapCountDialogTextPrimary": "Would you like to increase the value of vm.max_map_count to {0}",
+  "LinuxVmMaxMapCountDialogTextSecondary": "Some games might try to create more memory mappings than currently allowed. Ryujinx will crash as soon as this limit gets exceeded.",
+  "LinuxVmMaxMapCountDialogButtonUntilRestart": "Yes, until the next restart",
+  "LinuxVmMaxMapCountDialogButtonPersistent": "Yes, permanently",
+  "LinuxVmMaxMapCountWarningTextPrimary": "Max amount of memory mappings is lower than recommended.",
+  "LinuxVmMaxMapCountWarningTextSecondary": "The current value of vm.max_map_count ({0}) is lower than {1}. Some games might try to create more memory mappings than currently allowed. Ryujinx will crash as soon as this limit gets exceeded.\n\nYou might want to either manually increase the limit or install pkexec, which allows Ryujinx to assist with that.",
   "Settings": "Settings",
   "SettingsTabGeneral": "User Interface",
   "SettingsTabGeneralGeneral": "General",

src/Ryujinx.Ava/Ryujinx.Ava.csproj

@@ -18,6 +18,7 @@
 
   <PropertyGroup Condition="'$(RuntimeIdentifier)' != ''">
     <PublishSingleFile>true</PublishSingleFile>
+    <TrimmerSingleWarn>false</TrimmerSingleWarn>
     <PublishTrimmed>true</PublishTrimmed>
     <TrimMode>partial</TrimMode>
   </PropertyGroup>
@@ -147,4 +148,4 @@
   <ItemGroup>
     <AdditionalFiles Include="Assets\Locales\en_US.json" />
   </ItemGroup>
-</Project>
+</Project>

src/Ryujinx.Ava/UI/Helpers/ContentDialogHelper.cs

@@ -6,7 +6,6 @@ using Avalonia.Threading;
 using FluentAvalonia.Core;
 using FluentAvalonia.UI.Controls;
 using Ryujinx.Ava.Common.Locale;
-using Ryujinx.Ava.UI.Controls;
 using Ryujinx.Ava.UI.Windows;
 using Ryujinx.Common.Logging;
 using System;
@@ -19,7 +18,7 @@ namespace Ryujinx.Ava.UI.Helpers
     {
         private static bool _isChoiceDialogOpen;
 
-        public async static Task<UserResult> ShowContentDialog(
+        private async static Task<UserResult> ShowContentDialog(
              string title,
              object content,
              string primaryButton,
@@ -67,7 +66,7 @@ namespace Ryujinx.Ava.UI.Helpers
             return result;
         }
 
-        private async static Task<UserResult> ShowTextDialog(
+        public async static Task<UserResult> ShowTextDialog(
             string title,
             string primaryText,
             string secondaryText,
@@ -319,7 +318,7 @@ namespace Ryujinx.Ava.UI.Helpers
 
             Window parent = GetMainWindow();
 
-            if (parent != null && parent.IsActive && parent is MainWindow window && window.ViewModel.IsGameRunning)
+            if (parent is { IsActive: true } and MainWindow window && window.ViewModel.IsGameRunning)
             {
                 contentDialogOverlayWindow = new()
                 {

src/Ryujinx.Ava/UI/Windows/MainWindow.axaml.cs

@@ -23,6 +23,7 @@ using Ryujinx.Ui.Common.Helper;
 using System;
 using System.ComponentModel;
 using System.IO;
+using System.Runtime.Versioning;
 using System.Threading.Tasks;
 using InputManager = Ryujinx.Input.HLE.InputManager;
 
@@ -258,7 +259,64 @@ namespace Ryujinx.Ava.UI.Windows
             ApplicationHelper.Initialize(VirtualFileSystem, AccountManager, LibHacHorizonManager.RyujinxClient, this);
         }
 
-        protected void CheckLaunchState()
+        [SupportedOSPlatform("linux")]
+        private static async void ShowVmMaxMapCountWarning()
+        {
+            LocaleManager.Instance.UpdateAndGetDynamicValue(LocaleKeys.LinuxVmMaxMapCountWarningTextSecondary,
+                LinuxHelper.VmMaxMapCount, LinuxHelper.RecommendedVmMaxMapCount);
+
+            await ContentDialogHelper.CreateWarningDialog(
+                LocaleManager.Instance[LocaleKeys.LinuxVmMaxMapCountWarningTextPrimary],
+                LocaleManager.Instance[LocaleKeys.LinuxVmMaxMapCountWarningTextSecondary]
+            );
+        }
+
+        [SupportedOSPlatform("linux")]
+        private static async void ShowVmMaxMapCountDialog()
+        {
+            LocaleManager.Instance.UpdateAndGetDynamicValue(LocaleKeys.LinuxVmMaxMapCountDialogTextPrimary,
+                LinuxHelper.RecommendedVmMaxMapCount);
+
+            UserResult response = await ContentDialogHelper.ShowTextDialog(
+                $"Ryujinx - {LocaleManager.Instance[LocaleKeys.LinuxVmMaxMapCountDialogTitle]}",
+                LocaleManager.Instance[LocaleKeys.LinuxVmMaxMapCountDialogTextPrimary],
+                LocaleManager.Instance[LocaleKeys.LinuxVmMaxMapCountDialogTextSecondary],
+                LocaleManager.Instance[LocaleKeys.LinuxVmMaxMapCountDialogButtonUntilRestart],
+                LocaleManager.Instance[LocaleKeys.LinuxVmMaxMapCountDialogButtonPersistent],
+                LocaleManager.Instance[LocaleKeys.InputDialogNo],
+                (int)Symbol.Help
+            );
+
+            int rc;
+
+            switch (response)
+            {
+                case UserResult.Ok:
+                    rc = LinuxHelper.RunPkExec($"echo {LinuxHelper.RecommendedVmMaxMapCount} > {LinuxHelper.VmMaxMapCountPath}");
+                    if (rc == 0)
+                    {
+                        Logger.Info?.Print(LogClass.Application, $"vm.max_map_count set to {LinuxHelper.VmMaxMapCount} until the next restart.");
+                    }
+                    else
+                    {
+                        Logger.Error?.Print(LogClass.Application, $"Unable to change vm.max_map_count. Process exited with code: {rc}");
+                    }
+                    break;
+                case UserResult.No:
+                    rc = LinuxHelper.RunPkExec($"echo \"vm.max_map_count = {LinuxHelper.RecommendedVmMaxMapCount}\" > {LinuxHelper.SysCtlConfigPath} && sysctl -p {LinuxHelper.SysCtlConfigPath}");
+                    if (rc == 0)
+                    {
+                        Logger.Info?.Print(LogClass.Application, $"vm.max_map_count set to {LinuxHelper.VmMaxMapCount}. Written to config: {LinuxHelper.SysCtlConfigPath}");
+                    }
+                    else
+                    {
+                        Logger.Error?.Print(LogClass.Application, $"Unable to write new value for vm.max_map_count to config. Process exited with code: {rc}");
+                    }
+                    break;
+            }
+        }
+
+        private void CheckLaunchState()
         {
             if (ShowKeyErrorOnLoad)
             {
@@ -268,6 +326,20 @@ namespace Ryujinx.Ava.UI.Windows
                     UserErrorDialog.ShowUserErrorDialog(UserError.NoKeys, this));
             }
 
+            if (OperatingSystem.IsLinux() && LinuxHelper.VmMaxMapCount < LinuxHelper.RecommendedVmMaxMapCount)
+            {
+                Logger.Warning?.Print(LogClass.Application, $"The value of vm.max_map_count is lower than {LinuxHelper.RecommendedVmMaxMapCount}. ({LinuxHelper.VmMaxMapCount})");
+
+                if (LinuxHelper.PkExecPath is not null)
+                {
+                    Dispatcher.UIThread.Post(ShowVmMaxMapCountDialog);
+                }
+                else
+                {
+                    Dispatcher.UIThread.Post(ShowVmMaxMapCountWarning);
+                }
+            }
+
             if (_deferLoad)
             {
                 _deferLoad = false;

src/Ryujinx.Memory/MemoryManagementUnix.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Concurrent;
+using System.Runtime.InteropServices;
 using System.Runtime.Versioning;
 using System.Text;
 
@@ -53,9 +54,9 @@ namespace Ryujinx.Memory
 
             IntPtr ptr = mmap(IntPtr.Zero, size, prot, flags, -1, 0);
 
-            if (ptr == new IntPtr(-1L))
+            if (ptr == MAP_FAILED)
             {
-                throw new OutOfMemoryException();
+                throw new SystemException(Marshal.GetLastPInvokeErrorMessage());
             }
 
             if (!_allocations.TryAdd(ptr, size))
@@ -76,17 +77,33 @@ namespace Ryujinx.Memory
                 prot |= MmapProts.PROT_EXEC;
             }
 
-            return mprotect(address, size, prot) == 0;
+            if (mprotect(address, size, prot) != 0)
+            {
+                throw new SystemException(Marshal.GetLastPInvokeErrorMessage());
+            }
+
+            return true;
         }
 
         public static bool Decommit(IntPtr address, ulong size)
         {
             // Must be writable for madvise to work properly.
-            mprotect(address, size, MmapProts.PROT_READ | MmapProts.PROT_WRITE);
+            if (mprotect(address, size, MmapProts.PROT_READ | MmapProts.PROT_WRITE) != 0)
+            {
+                throw new SystemException(Marshal.GetLastPInvokeErrorMessage());
+            }
 
-            madvise(address, size, MADV_REMOVE);
+            if (madvise(address, size, MADV_REMOVE) != 0)
+            {
+                throw new SystemException(Marshal.GetLastPInvokeErrorMessage());
+            }
+
+            if (mprotect(address, size, MmapProts.PROT_NONE) != 0)
+            {
+                throw new SystemException(Marshal.GetLastPInvokeErrorMessage());
+            }
 
-            return mprotect(address, size, MmapProts.PROT_NONE) == 0;
+            return true;
         }
 
         public static bool Reprotect(IntPtr address, ulong size, MemoryPermission permission)

src/Ryujinx.Memory/MemoryManagementWindows.cs

@@ -1,5 +1,6 @@
 using Ryujinx.Memory.WindowsShared;
 using System;
+using System.Runtime.InteropServices;
 using System.Runtime.Versioning;
 
 namespace Ryujinx.Memory
@@ -36,7 +37,7 @@ namespace Ryujinx.Memory
 
             if (ptr == IntPtr.Zero)
             {
-                throw new OutOfMemoryException();
+                throw new SystemException(Marshal.GetLastPInvokeErrorMessage());
             }
 
             return ptr;
@@ -48,7 +49,7 @@ namespace Ryujinx.Memory
 
             if (ptr == IntPtr.Zero)
             {
-                throw new OutOfMemoryException();
+                throw new SystemException(Marshal.GetLastPInvokeErrorMessage());
             }
 
             return ptr;

src/Ryujinx.Memory/MemoryManagerUnixHelper.cs

@@ -1,8 +1,11 @@
 using System;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 
 namespace Ryujinx.Memory
 {
+    [SupportedOSPlatform("linux")]
+    [SupportedOSPlatform("macos")]
     public static partial class MemoryManagerUnixHelper
     {
         [Flags]
@@ -41,6 +44,8 @@ namespace Ryujinx.Memory
             O_SYNC = 256,
         }
 
+        public const IntPtr MAP_FAILED = -1;
+
         private const int MAP_ANONYMOUS_LINUX_GENERIC = 0x20;
         private const int MAP_NORESERVE_LINUX_GENERIC = 0x4000;
         private const int MAP_UNLOCKED_LINUX_GENERIC = 0x80000;

src/Ryujinx.Memory/MemoryProtectionException.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Runtime.InteropServices;
 
 namespace Ryujinx.Memory
 {
@@ -8,7 +9,7 @@ namespace Ryujinx.Memory
         {
         }
 
-        public MemoryProtectionException(MemoryPermission permission) : base($"Failed to set memory protection to \"{permission}\".")
+        public MemoryProtectionException(MemoryPermission permission) : base($"Failed to set memory protection to \"{permission}\": {Marshal.GetLastPInvokeErrorMessage()}")
         {
         }
 

src/Ryujinx.Memory/WindowsShared/WindowsApi.cs

@@ -1,8 +1,10 @@
 using System;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 
 namespace Ryujinx.Memory.WindowsShared
 {
+    [SupportedOSPlatform("windows")]
     static partial class WindowsApi
     {
         public static readonly IntPtr InvalidHandleValue = new IntPtr(-1);

src/Ryujinx.Memory/WindowsShared/WindowsApiException.cs

@@ -1,7 +1,9 @@
 using System;
+using System.Runtime.Versioning;
 
 namespace Ryujinx.Memory.WindowsShared
 {
+    [SupportedOSPlatform("windows")]
     class WindowsApiException : Exception
     {
         public WindowsApiException()

src/Ryujinx.Ui.Common/Helper/LinuxHelper.cs

@@ -0,0 +1,62 @@
+using System;
+using System.Diagnostics;
+using System.IO;
+using System.Runtime.Versioning;
+
+namespace Ryujinx.Ui.Common.Helper
+{
+    [SupportedOSPlatform("linux")]
+    public static class LinuxHelper
+    {
+        // NOTE: This value was determined by manual tests and might need to be increased again.
+        public const int RecommendedVmMaxMapCount = 524288;
+        public const string VmMaxMapCountPath = "/proc/sys/vm/max_map_count";
+        public const string SysCtlConfigPath = "/etc/sysctl.d/99-Ryujinx.conf";
+        public static int VmMaxMapCount => int.Parse(File.ReadAllText(VmMaxMapCountPath));
+        public static string PkExecPath { get; } = GetBinaryPath("pkexec");
+
+        private static string GetBinaryPath(string binary)
+        {
+            string pathVar = Environment.GetEnvironmentVariable("PATH");
+
+            if (pathVar is null || string.IsNullOrEmpty(binary))
+            {
+                return null;
+            }
+
+            foreach (var searchPath in pathVar.Split(":", StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries))
+            {
+                string binaryPath = Path.Combine(searchPath, binary);
+
+                if (File.Exists(binaryPath))
+                {
+                    return binaryPath;
+                }
+            }
+
+            return null;
+        }
+
+        public static int RunPkExec(string command)
+        {
+            if (PkExecPath == null)
+            {
+                return 1;
+            }
+
+            using Process process = new()
+            {
+                StartInfo =
+                {
+                    FileName = PkExecPath,
+                    ArgumentList = { "sh", "-c", command }
+                }
+            };
+
+            process.Start();
+            process.WaitForExit();
+
+            return process.ExitCode;
+        }
+    }
+}

src/Ryujinx/Program.cs

@@ -264,6 +264,71 @@ namespace Ryujinx
             MainWindow mainWindow = new MainWindow();
             mainWindow.Show();
 
+            if (OperatingSystem.IsLinux())
+            {
+                int currentVmMaxMapCount = LinuxHelper.VmMaxMapCount;
+
+                if (LinuxHelper.VmMaxMapCount < LinuxHelper.RecommendedVmMaxMapCount)
+                {
+                    Logger.Warning?.Print(LogClass.Application, $"The value of vm.max_map_count is lower than {LinuxHelper.RecommendedVmMaxMapCount}. ({currentVmMaxMapCount})");
+
+                    if (LinuxHelper.PkExecPath is not null)
+                    {
+                        var buttonTexts = new Dictionary<int, string>()
+                        {
+                            { 0, "Yes, until the next restart" },
+                            { 1, "Yes, permanently" },
+                            { 2, "No" }
+                        };
+
+                        ResponseType response = GtkDialog.CreateCustomDialog(
+                            "Ryujinx - Low limit for memory mappings detected",
+                            $"Would you like to increase the value of vm.max_map_count to {LinuxHelper.RecommendedVmMaxMapCount}?",
+                            "Some games might try to create more memory mappings than currently allowed. " +
+                            "Ryujinx will crash as soon as this limit gets exceeded.",
+                            buttonTexts,
+                            MessageType.Question);
+
+                        int rc;
+
+                        switch ((int)response)
+                        {
+                            case 0:
+                                rc = LinuxHelper.RunPkExec($"echo {LinuxHelper.RecommendedVmMaxMapCount} > {LinuxHelper.VmMaxMapCountPath}");
+                                if (rc == 0)
+                                {
+                                    Logger.Info?.Print(LogClass.Application, $"vm.max_map_count set to {LinuxHelper.VmMaxMapCount} until the next restart.");
+                                }
+                                else
+                                {
+                                    Logger.Error?.Print(LogClass.Application, $"Unable to change vm.max_map_count. Process exited with code: {rc}");
+                                }
+                                break;
+                            case 1:
+                                rc = LinuxHelper.RunPkExec($"echo \"vm.max_map_count = {LinuxHelper.RecommendedVmMaxMapCount}\" > {LinuxHelper.SysCtlConfigPath} && sysctl -p {LinuxHelper.SysCtlConfigPath}");
+                                if (rc == 0)
+                                {
+                                    Logger.Info?.Print(LogClass.Application, $"vm.max_map_count set to {LinuxHelper.VmMaxMapCount}. Written to config: {LinuxHelper.SysCtlConfigPath}");
+                                }
+                                else
+                                {
+                                    Logger.Error?.Print(LogClass.Application, $"Unable to write new value for vm.max_map_count to config. Process exited with code: {rc}");
+                                }
+                                break;
+                        }
+                    }
+                    else
+                    {
+                        GtkDialog.CreateWarningDialog(
+                            "Max amount of memory mappings is lower than recommended.",
+                            $"The current value of vm.max_map_count ({currentVmMaxMapCount}) is lower than {LinuxHelper.RecommendedVmMaxMapCount}." +
+                            "Some games might try to create more memory mappings than currently allowed. " +
+                            "Ryujinx will crash as soon as this limit gets exceeded.\n\n" +
+                            "You might want to either manually increase the limit or install pkexec, which allows Ryujinx to assist with that.");
+                    }
+                }
+            }
+
             if (CommandLineState.LaunchPathArg != null)
             {
                 mainWindow.RunApplication(CommandLineState.LaunchPathArg, CommandLineState.StartFullscreenArg);

src/Ryujinx/Ryujinx.csproj

@@ -14,6 +14,7 @@
 
   <PropertyGroup Condition="'$(RuntimeIdentifier)' != ''">
     <PublishSingleFile>true</PublishSingleFile>
+    <TrimmerSingleWarn>false</TrimmerSingleWarn>
     <PublishTrimmed>true</PublishTrimmed>
     <TrimMode>partial</TrimMode>
   </PropertyGroup>
@@ -100,4 +101,4 @@
     <EmbeddedResource Include="Modules\Updater\UpdateDialog.glade" />
   </ItemGroup>
 
-</Project>
+</Project>