[release/3.12] 通过 Java Agent 优化 LWJGL 3.4.1 性能 (#5886)

#5870
#5873
#5874
#5882

---------

Co-authored-by: 3gf8jv4dv <3gf8jv4dv@gmail.com>

Author: Glavo

HMCL/build.gradle.kts

@@ -66,6 +66,7 @@ dependencies {
     }
 
     embedResources(libs.authlib.injector)
+    embedResources(libs.lwjgl.unsafe.agent)
 }
 
 fun digest(algorithm: String, bytes: ByteArray): ByteArray = MessageDigest.getInstance(algorithm).digest(bytes)
@@ -155,6 +156,7 @@ val hmclProperties = buildList {
     add("hmcl.microsoft.auth.id" to microsoftAuthId)
     add("hmcl.curseforge.apikey" to curseForgeApiKey)
     add("hmcl.authlib-injector.version" to libs.authlib.injector.get().version!!)
+    add("hmcl.lwjgl-unsafe-agent.version" to libs.lwjgl.unsafe.agent.get().version!!)
 }
 
 val hmclPropertiesFile = layout.buildDirectory.file("hmcl.properties")

HMCL/src/main/java/org/jackhuang/hmcl/game/HMCLGameLauncher.java

@@ -21,12 +21,16 @@
 import org.jackhuang.hmcl.auth.AuthInfo;
 import org.jackhuang.hmcl.launch.DefaultLauncher;
 import org.jackhuang.hmcl.launch.ProcessListener;
+import org.jackhuang.hmcl.util.NativePatcher;
 import org.jackhuang.hmcl.util.i18n.LocaleUtils;
 import org.jackhuang.hmcl.util.io.FileUtils;
+import org.jackhuang.hmcl.util.io.JarUtils;
+import org.jackhuang.hmcl.util.platform.CommandBuilder;
 import org.jackhuang.hmcl.util.platform.ManagedProcess;
 import org.jackhuang.hmcl.util.versioning.GameVersionNumber;
 
 import java.io.IOException;
+import java.io.InputStream;
 import java.nio.file.*;
 import java.util.*;
 import java.util.stream.Stream;
@@ -150,4 +154,60 @@ public void makeLaunchScript(Path scriptFile) throws IOException {
         generateOptionsTxt();
         super.makeLaunchScript(scriptFile);
     }
+
+    @Override
+    protected void appendJvmArgs(CommandBuilder result) {
+        super.appendJvmArgs(result);
+
+        if (config().getAllowAutoAgent()
+                && !options.isNoGeneratedJVMArgs()
+                && !options.isNoGeneratedOptimizingJVMArgs()
+                && NativePatcher.needPatchMemoryUtil(version, options.getJava().getParsedVersion())) {
+            LOG.info("Attempting to patch game with lwjgl-unsafe-agent");
+            try {
+                result.add("-javaagent:" + extractLwjglUnsafeAgent());
+            } catch (Exception e) {
+                LOG.warning("Failed to extract lwjgl-unsafe-agent", e);
+            }
+        }
+    }
+
+    private Path extractLwjglUnsafeAgent() throws IOException {
+        String agentVersion = JarUtils.getAttribute("hmcl.lwjgl-unsafe-agent.version", null);
+        if (agentVersion == null) {
+            throw new IOException("Missing hmcl.lwjgl-unsafe-agent.version attribute");
+        }
+
+        Library library = new Library(new Artifact("org.glavo", "lwjgl-unsafe-agent", agentVersion));
+        String fileName = library.getArtifact().getFileName();
+
+        Path agentPath = repository.getLibraryFile(version, library).toAbsolutePath().normalize();
+        if (agentPath.toString().contains("=")) {
+            throw new IOException("Invalid library path: " + agentPath);
+        }
+
+        byte[] bytes;
+        try (InputStream input = DefaultLauncher.class.getResourceAsStream("/assets/" + fileName)) {
+            if (input == null) {
+                throw new IOException("/assets/" + fileName + " not found");
+            }
+
+            bytes = input.readAllBytes();
+        }
+
+        if (Files.isRegularFile(agentPath)) {
+            try {
+                if (Files.size(agentPath) == bytes.length) {
+                    return agentPath;
+                }
+            } catch (IOException e) {
+                LOG.warning("Failed to check size of " + agentPath, e);
+            }
+        }
+
+        Files.createDirectories(agentPath.getParent());
+        FileUtils.saveSafely(agentPath, output -> output.write(bytes));
+        return agentPath;
+    }
+
 }

HMCL/src/main/java/org/jackhuang/hmcl/game/LauncherHelper.java

@@ -65,6 +65,7 @@
 
 import static javafx.application.Platform.runLater;
 import static javafx.application.Platform.setImplicitExit;
+import static org.jackhuang.hmcl.setting.ConfigHolder.config;
 import static org.jackhuang.hmcl.ui.FXUtils.runInFX;
 import static org.jackhuang.hmcl.util.DataSizeUnit.MEGABYTES;
 import static org.jackhuang.hmcl.util.Lang.resolveException;
@@ -75,6 +76,8 @@
 
 public final class LauncherHelper {
 
+    private static final String LWJGL_3_4_1_TIP = "lwjgl3.4.1-ffm";
+
     private final Profile profile;
     private Account account;
     private final String selectedVersion;
@@ -197,6 +200,28 @@ private void launch0() {
                     );
                 }).withStage("launch.state.dependencies")
                 .thenComposeAsync(() -> gameVersion.map(s -> new GameVerificationFixTask(dependencyManager, s, version.get())).orElse(null))
+                .thenComposeAsync(() -> {
+                    if (config().getAllowAutoAgent()
+                            || setting.isNoJVMArgs()
+                            || setting.isNoOptimizingJVMArgs()
+                            || Boolean.TRUE.equals(config().getShownTips().get(LWJGL_3_4_1_TIP))
+                            || !NativePatcher.needPatchMemoryUtil(version.get(), javaVersionRef.get().getParsedVersion())) {
+                        return Task.completed(null);
+                    } else {
+                        CompletableFuture<Void> future = new CompletableFuture<>();
+                        runInFX(() -> {
+                            Controllers.confirm(i18n("launch.advice.lwjgl_3_4_1"), i18n("launch.advice.lwjgl_3_4_1.title"), MessageType.QUESTION, () -> {
+                                config().getShownTips().put(LWJGL_3_4_1_TIP, true);
+                                config().setAllowAutoAgent(true);
+                                future.complete(null);
+                            }, () -> {
+                                config().getShownTips().put(LWJGL_3_4_1_TIP, true);
+                                future.complete(null);
+                            });
+                        });
+                        return Task.fromCompletableFuture(future);
+                    }
+                })
                 .thenComposeAsync(() -> logIn(account).withStage("launch.state.logging_in"))
                 .thenComposeAsync(authInfo -> Task.supplyAsync(() -> {
                     LaunchOptions.Builder launchOptionsBuilder = repository.getLaunchOptions(

HMCL/src/main/java/org/jackhuang/hmcl/setting/Config.java

@@ -689,6 +689,21 @@ public void setDisableAutoGameOptions(boolean disableAutoGameOptions) {
         this.disableAutoGameOptions.set(disableAutoGameOptions);
     }
 
+    @SerializedName("allowAutoAgent")
+    private final BooleanProperty allowAutoAgent = new SimpleBooleanProperty(false);
+
+    public BooleanProperty allowAutoAgentProperty() {
+        return allowAutoAgent;
+    }
+
+    public boolean getAllowAutoAgent() {
+        return allowAutoAgent.get();
+    }
+
+    public void setAllowAutoAgent(boolean allowAutoAgent) {
+        this.allowAutoAgent.set(allowAutoAgent);
+    }
+
     // Accounts
 
     @SerializedName("authlibInjectorServers")

HMCL/src/main/java/org/jackhuang/hmcl/ui/main/SettingsPage.java

@@ -288,6 +288,15 @@ else if (locale.isSameLanguage(currentLocale))
                 settingsPane.getContent().add(disableAutoGameOptionsPane);
             }
 
+            {
+                LineToggleButton allowAutoAgentPane = new LineToggleButton();
+                allowAutoAgentPane.setTitle(i18n("settings.launcher.allow_auto_agent"));
+                allowAutoAgentPane.setSubtitle(i18n("settings.launcher.allow_auto_agent.subtitle"));
+                allowAutoAgentPane.selectedProperty().bindBidirectional(config().allowAutoAgentProperty());
+
+                settingsPane.getContent().add(allowAutoAgentPane);
+            }
+
             {
                 BorderPane debugPane = new BorderPane();
 

HMCL/src/main/java/org/jackhuang/hmcl/util/NativePatcher.java

@@ -63,6 +63,16 @@ private static Map<String, Library> getNatives(Platform platform) {
         });
     }
 
+    // https://github.com/LWJGL/lwjgl3/issues/1111
+    public static boolean needPatchMemoryUtil(Version version, int javaVersion) {
+        return javaVersion >= 25 && javaVersion <= 26 && version.getLibraries().stream().anyMatch(library ->
+                "org.lwjgl".equals(library.getGroupId())
+                        && "lwjgl".equals(library.getArtifactId())
+                        && "3.4.1".equals(library.getVersion())
+                        && library.getClassifier() == null
+        );
+    }
+
     public static Version patchNative(DefaultGameRepository repository,
                                       Version version, String gameVersion,
                                       JavaRuntime javaVersion,

HMCL/src/main/resources/assets/lang/I18N.properties

@@ -808,6 +808,8 @@ launch.advice.forge37_0_60=Forge versions prior to 37.0.60 are not compatible wi
 launch.advice.java8_1_13=Minecraft 1.13 and later can only be run on Java 8 or later. Please use Java 8 or later versions.
 launch.advice.java8_51_1_13=Minecraft 1.13 may crash on Java 8 versions prior to 1.8.0_51. Please install the latest Java 8 version.
 launch.advice.java9=You cannot launch Minecraft 1.12 or earlier with Java 9 or later. Please use Java 8 instead.
+launch.advice.lwjgl_3_4_1=The current game version has a known issue that may cause stuttering in the game.\nHMCL can automatically optimize the game performance (using a Java Agent).\nDo you allow HMCL to automatically optimize the game?\nIf you encounter issues, you can disable the "Allow HMCL to modify the game" option in "Settings → General".
+launch.advice.lwjgl_3_4_1.title=Allow HMCL to automatically optimize the game?
 launch.advice.modded_java=Some mods may not be compatible with newer Java versions. It is recommended to use Java %1$s to launch Minecraft %2$s.
 launch.advice.modlauncher8=The Forge version you are using is not compatible with the current Java version. Please try updating Forge.
 launch.advice.newer_java=You are using an older Java version to launch the game. It is recommended to update to Java 8, otherwise some mods may cause the game to crash.
@@ -1416,6 +1418,8 @@ settings.game.working_directory.hint=Enable the "Isolated" option in "Working Di
 settings.icon=Icon
 
 settings.launcher=Launcher Settings
+settings.launcher.allow_auto_agent=Allow HMCL to modify the game
+settings.launcher.allow_auto_agent.subtitle=Allow HMCL to modify the game by attaching a Java Agent to improve the gaming experience.
 settings.launcher.appearance=Appearance
 settings.launcher.brightness=Theme Mode
 settings.launcher.brightness.auto=Follow System Settings

HMCL/src/main/resources/assets/lang/I18N_lzh.properties

@@ -579,6 +579,8 @@ launch.advice.forge37_0_60=鍛三七點〇點五九與舊者弗兼爪哇十七
 launch.advice.java8_1_13=礦藝一點一三以晉但行於爪哇八與晉者。宜行以爪哇八與晉者。
 launch.advice.java8_51_1_13=爪哇之前一點八點〇之五一者或崩礦藝一點一三。宜新爪哇於一點八點〇之五一以晉，然後復啟。
 launch.advice.java9=礦藝之前一點一三而有改囊者弗見兼於爪哇九與晉者。宜啟以爪哇八。
+launch.advice.lwjgl_3_4_1=戲之是版有已知之謬，行戲之時或致頓滯。\nHMCL 可假爪哇 Agent 自優其戲，以弭是患。君其許 HMCL 自優其戲乎？\n誠有謬，可至於「置設 → 貫用」，廢「許改戲」之項。
+launch.advice.lwjgl_3_4_1.title=君其許 HMCL 自優其戲乎？
 launch.advice.modded_java=改囊或弗見兼於爪哇之新者。宜以爪哇 %s 啟礦藝 %s。
 launch.advice.modlauncher8=鍛版之所行弗兼於爪哇之所行。宜新鍛。
 launch.advice.newer_java=余識君之啟戲以舊爪哇也，蓋改囊或是以崩戲也。宜新爪哇於八，然後復啟。
@@ -1126,6 +1128,8 @@ settings.game.working_directory.hint=夫于「運徑」擇「例獨」者，可
 settings.icon=戲徵
 
 settings.launcher=啟者置設
+settings.launcher.allow_auto_agent=許改戲
+settings.launcher.allow_auto_agent.subtitle=許 HMCL 假附加爪哇 Agent 以改戲，而優其戲感。
 settings.launcher.appearance=外觀
 settings.launcher.common_path.tooltip=啟者置戲資與府庫於是。倘戲有成案，則弗取公庫之案。
 settings.launcher.debug=勘誤

HMCL/src/main/resources/assets/lang/I18N_zh.properties

@@ -612,6 +612,8 @@ launch.advice.forge37_0_60=Forge 37.0.59 及更低版本與 Java 17 不相容。
 launch.advice.java8_1_13=Minecraft 1.13 及更高版本僅支援 Java 8 或更高版本。請使用 Java 8 或最新版本。
 launch.advice.java8_51_1_13=低於 1.8.0_51 的 Java 版本可能會導致 Minecraft 1.13 崩潰。建議你到 https://java.com 安裝最新版的 Java 8。
 launch.advice.java9=低於 (包含) 1.13 的有安裝模組的 Minecraft 版本不支援 Java 9 或更高版本。請使用 Java 8。
+launch.advice.lwjgl_3_4_1=當前遊戲版本存在已知問題，可能在遊戲中發生卡頓。\nHMCL 可以 (透過 Java Agent) 自動最佳化遊戲解決此問題。是否允許 HMCL 自動最佳化遊戲？\n如遇到問題，你可以在「設定 → 一般」中關閉「允許 HMCL 修改遊戲」選項。
+launch.advice.lwjgl_3_4_1.title=是否允許 HMCL 自動最佳化遊戲？
 launch.advice.modded_java=部分模組可能與高版本 Java 不相容。建議使用 Java %s 啟動 Minecraft %s。
 launch.advice.modlauncher8=你所使用的 Forge 版本與目前使用的 Java 不相容。請更新 Forge。
 launch.advice.newer_java=偵測到你正在使用舊版本 Java 啟動遊戲，這可能導致部分模組引發遊戲崩潰。建議更新至 Java 8 後再次啟動。
@@ -1201,6 +1203,8 @@ settings.game.working_directory.hint=在「執行路徑」選項中選取「各
 settings.icon=遊戲圖示
 
 settings.launcher=啟動器設定
+settings.launcher.allow_auto_agent=允許 HMCL 修改遊戲
+settings.launcher.allow_auto_agent.subtitle=允許 HMCL 透過附加 Java Agent 修改遊戲以改善遊戲體驗。
 settings.launcher.appearance=外觀
 settings.launcher.brightness=主題模式
 settings.launcher.brightness.auto=跟隨系統設定

HMCL/src/main/resources/assets/lang/I18N_zh_CN.properties

@@ -617,6 +617,8 @@ launch.advice.forge37_0_60=Forge 37.0.59 及更低版本与 Java 17 不兼容。
 launch.advice.java8_1_13=Minecraft 1.13 及更高版本只能在 Java 8 或更高版本上运行。请使用 Java 8 或最新版本。
 launch.advice.java8_51_1_13=低于 1.8.0_51 的 Java 版本可能会导致 Minecraft 1.13 崩溃。建议更新 Java 至 1.8.0_51 或更高版本后再次启动。
 launch.advice.java9=低于 1.13 的有安装模组的 Minecraft 版本与 Java 9 或更高版本不兼容。请使用 Java 8。
+launch.advice.lwjgl_3_4_1=当前游戏版本存在已知问题，可能在游戏中发生卡顿。\nHMCL 可以 (通过 Java Agent) 自动优化游戏解决此问题。是否允许 HMCL 自动优化游戏？\n如遇到问题，你可以在“设置 → 通用”中关闭“允许 HMCL 修改游戏”选项。
+launch.advice.lwjgl_3_4_1.title=是否允许 HMCL 自动优化游戏？
 launch.advice.modded_java=部分模组可能与高版本 Java 不兼容。建议使用 Java %s 启动 Minecraft %s。
 launch.advice.modlauncher8=你所使用的 Forge 版本与当前使用的 Java 不兼容。请更新 Forge。
 launch.advice.newer_java=检测到你正在使用旧版本 Java 启动游戏，这可能导致部分模组引发游戏崩溃。建议更新至 Java 8 后再次启动。
@@ -1206,6 +1208,8 @@ settings.game.working_directory.hint=在“版本隔离”中选择“各实例
 settings.icon=游戏图标
 
 settings.launcher=启动器设置
+settings.launcher.allow_auto_agent=允许 HMCL 修改游戏
+settings.launcher.allow_auto_agent.subtitle=允许 HMCL 通过附加 Java Agent 修改游戏以改善游戏体验。
 settings.launcher.appearance=外观
 settings.launcher.brightness=主题模式
 settings.launcher.brightness.auto=跟随系统设置