Increase memory used for forked compiler #1753
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When running the Gradle Daemon with a non-J21 JVM, it will fork the Java compiler into a separate process rather than running it in-process with the Daemon. However, that means the compiler process uses the default amount of memory, which is not able to compile all of NeoForge & Minecraft (as it fails with an OutOfMemoryError). Setting the memory when the compiler is forked ensures that whether the compiler runs in-process with the Daemon or as a forked process, it will always have enough memory to compile all the sources properly.
sciwhiz12
added
bug
Last commit published: b961a4b5a7def793d906530bd3d256f5bcccb4ff. PR PublishingThe artifacts published by this PR:
Repository DeclarationIn order to use the artifacts published by the PR, add the following repository to your buildscript: repositories {
maven {
name 'Maven for PR #1753' // https://github.com/neoforged/NeoForge/pull/1753
url 'https://prmaven.neoforged.net/NeoForge/pr1753'
content {
includeModule('net.neoforged', 'testframework')
includeModule('net.neoforged', 'neoforge')
}
}
}MDK installationIn order to setup a MDK using the latest PR version, run the following commands in a terminal. mkdir NeoForge-pr1753
cd NeoForge-pr1753
curl -L https://prmaven.neoforged.net/NeoForge/pr1753/net/neoforged/neoforge/21.4.17-beta-pr-1753-neoforge-compiler-memory/mdk-pr1753.zip -o mdk.zip
jar xf mdk.zip
rm mdk.zip || del mdk.zipTo test a production environment, you can download the installer from here. |
Technici4n
reviewed
Dec 10, 2024
Technici4n
reviewed
Dec 10, 2024
Technici4n
previously approved these changes
Dec 10, 2024
The Daemon should require less memory as more things are now run out of process. This also matches the max memory argument passed to the compile tasks.
Technici4n
approved these changes
Dec 10, 2024
embeddedt
approved these changes
Dec 11, 2024
|
🚀 This PR has been released as NeoForge version |
Soaryn
pushed a commit
to Soaryn/EnergyHandlerPR
that referenced
this pull request
Jan 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes an out of memory error when compiling with a non-Java 21 JVM running the Gradle Daemon, by specifically setting the maximum memory used by the forked Java compiler process.
When running the Gradle Daemon with a non-J21 JVM, it will fork the Java compiler into a separate process rather than running it in-process with the Daemon. However, that means the compiler process uses the default amount of memory, which is not able to compile all of NeoForge & Minecraft (as it fails with an OutOfMemoryError).
Setting the memory when the compiler is forked ensures that whether the compiler runs in-process with the Daemon or as a forked process, it will always have enough memory to compile all the sources properly.
This is an alternative solution to the problem that #1692 also seeks to fix, which is more tailored to the problem by specifically addressing the root cause of the out-of-memory error.
To test, first set the Daemon to use a non-Java 21 JVM (via the
JAVA_HOMEenvironment variable pointed to a Java 17 JVM, for example), then run./gradlew clean,./gradlew setup(to prepare the workspace), then./gradlew assemble --no-build-cache --rerun-tasks. Without this PR,:neoforge:compileJavawill fail with a "Java heap space" error; with this PR, the build will succeed.