Replace `JAVA_OPTS` variable with `JAVA_TOOL_OPTIONS` #13256

JaroslavTulach · 2025-06-11T06:28:09Z

Pull Request Description

Use the standard _JAVA_OPTIONS environment variable where JAVA_OPTS option was used previously.

Important Notes

Is it OK to drop support for JAVA_OPTS in favor of _JAVA_OPTIONS?
Work on Dual NI + JVM Mode for Loading Libraries #13172 and particularly introduction of nested HotSpot JVM reveals questions how to pass arguments to it.
the standard way to pass debug arguments to HotSpot JVM is _JAVA_OPTIONS
as Channel connecting two JVM instances #13206 (comment) demonstrates
let's keep ENSO_JVM_OPTS as they are already used by our users

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

github-actions · 2025-06-11T06:29:07Z

✨ GUI Checks Results

Summary

🧹 Prettier: ✅ Passed
🧰 GUI Checks: ❌ Failed
📚 Storybook: ❌ Failed

⚠️ Action Required: Please review the failed checks and fix them before merging.

See individual check results for more details.

jdunkerley · 2025-06-11T08:20:29Z

Do we need to get clients using ENSO_JVM_OPTS to change things?

radeusgd · 2025-06-11T10:08:54Z

Do we need to get clients using ENSO_JVM_OPTS to change things?

Seems like that, since ENSO_JVM_OPTS seems to be no longer supported after this PR, if I read the code changes correctly.

JaroslavTulach · 2025-06-11T10:36:06Z

Do we need to get clients using ENSO_JVM_OPTS to change things?
Seems like that, since ENSO_JVM_OPTS seems to be no longer supported after this PR, if I read the code changes correctly.

Do we have clients using ENSO_JVM_OPTS? Ah, now I recon we do...
In such case we want to continue the ENSO_JVM_OPTS support.
Moreover right now I have problem with sbt:enso> runProjectManagerDistribution --debug as it tries to debug project-manager.jar...
I guess I back out 3ad53aa then ...
done in 492857e

…citly

JaroslavTulach · 2025-06-12T12:56:27Z

engine/runner/src/main/java/org/enso/runner/Utils.java

@@ -210,7 +210,7 @@ private static <S> void printFrame(
  static String adjustCwdToProject(String fileToRun) {
    assert fileToRun != null;
    if (!ImageInfo.inImageRuntimeCode()) {
-      return null;
+      return System.getProperty("enso.user.dir");


the 17e2200 change is unrelated to _JAVA_OPTIONS changed

but while testing various combinations of launcher I found out that

with native image enso launcher the following execution fails:

sbt:enso> runEngineDistribution --jvm --run test/Base_Tests

saying it cannot find test/Base_Tests project

the problem is that the NI part

properly resolves the project

changes CWD to the test directory

invokes the JVM main

however the CWD for the JVM part is already test directory

and resolving test/Base_Tests in that directory doesn't work

this change fixes the problem by providing the JVM part the location of the original CWD via a property

You set enso.user.dir with

commandAndArgs.add("-Denso.user.dir=" + originalCwdOrNull);

meaning that it can be -Denso.user.dir=null. And then when you get the property here, doesn't it return the "null" string?

JaroslavTulach · 2025-06-12T13:18:57Z

lib/java/os-environment/src/main/java/org/enso/os/environment/jni/JVM.java

@@ -41,15 +41,6 @@ public static JVM create(File javaHome, String... options) {
    // java.home
    jvmArgs.add("-Djava.home=" + javaHome);

-    var jvmOptions = System.getenv("JAVA_OPTS");


removal of this JAVA_OPTS handling is possible because the _JAVA_OPTIONS are "standard" JVM variables

we don't need to pass them around ourselves

the HotSpot JVM will pick them automatically up once it starts

it is small benefit, but it is a simplification of the code

hubertp · 2025-06-13T08:10:29Z

Any reason for preferring _JAVA_OPTIONS rather than JAVA_TOOL_OPTIONS? The former is undocumented, while the latter is.

Akirathan

Good simplification.

JaroslavTulach · 2025-06-13T09:07:51Z

Any reason for preferring _JAVA_OPTIONS rather than JAVA_TOOL_OPTIONS? The former is undocumented, while the latter is.

The difference on on GraalVM/OracleJVM is minimal as https://bugs.openjdk.org/browse/JDK-4971166 explains. But you are right, it is more standard to use JAVA_TOOL_OPTIONS:

Tool vendors need a uniform mechanism for adding options to a launch of the VM.
Particularly, they need a mechanism whereby they can launch agents (such as a
JVMTI agent) along with the VM, even if the VM is embedded.

So we need a new name and it should indicate it's intended usage so slightly
lessen the likelyhood of misuse -- JAVA_TOOL_OPTIONS.

Let's make the switch before integrating! Thanks for pointing that out. Done in 80cae79

…ew engine

JaroslavTulach · 2025-06-16T06:19:17Z

Current version of IGV doesn't run on JDK/GraalVM 24
there are problems with security manager - created Make IGV start on GraalVM 24.0.1 oracle/graal#11409
there are problems with --add-opens
turns out libgraal in GraalVM 24 doesn't support jdk.graal.PrintGraphPort property
only jargraal does it
as such IGV integration with Enso cannot dump graphs when running a file in the editor currently
but JAVA_TOOL_OPTIONS seem to work fine by itself

JAVA_TOOL_OPTIONS=--add-exports=java.base/jdk.internal.misc=jdk.graal.compiler,com.oracle.graal.graal_enterprise\
   -XX:-UseJVMCINativeLibrary\ 
  -Djdk.graal.Dump=:3\ 
  -Djdk.graal.PrintGraph=Network\
  ./enso --jvm --run ~/fac_tail.enso 10000

the above (put on a single line) does deliver graphs to IGV (on JDK21) via native image compiled enso

JaroslavTulach · 2025-06-16T06:51:41Z

While testing sbt runProjectManagerDistribution I found another problem (unrelated to JAVA_TOOL_OPTIONS):

[INFO] [2025-06-16T08:42:31.155] [org.enso.runtimeversionmanager.runner.Runner] Additional JVM options [-ea] from the ENSO_JVM_OPTS environment variable.

this happens only when the engine is native image. Because then the ENSO_JVM_OPTS aren't sent to the JVM, but are sent to the ./enso executable itself!

this problem was (somehow) observed at Make Native Image opt-out #12515 (comment)
ENSO_JVM_OPTS are changing its meaning completely in non-JVM and --jvm mode
e.g. there is no way to set ENSO_JVM_OPTS to non-trivial value that would work in both modes
the JVM mode is also controlled by jvm: true in the package.yaml
as such we can end up in a situation where users set ENSO_JVM_OPTS and then they can open just some of their projects
Per @hubertp request reported as ENSO_JVM_OPTS changes its meaning depending on jvm mode #13279

4e6 · 2025-06-16T15:22:25Z

distribution/bin/enso

@@ -1,5 +1,4 @@
 COMP_PATH=$(dirname "$0")/../component
-
-JAVA_OPTS="--enable-native-access=org.graalvm.truffle --sun-misc-unsafe-memory-access=allow --add-opens=java.base/java.nio=ALL-UNNAMED $JAVA_OPTS"
+JAVA_OPTS="--enable-native-access=org.graalvm.truffle --sun-misc-unsafe-memory-access=allow --add-opens=java.base/java.nio=ALL-UNNAMED"


That changes the behavior slightly but I understand why it is done this way.

4e6 · 2025-06-16T15:32:41Z

engine/runner/src/main/java/org/enso/runner/Utils.java

@@ -210,7 +210,7 @@ private static <S> void printFrame(
  static String adjustCwdToProject(String fileToRun) {
    assert fileToRun != null;
    if (!ImageInfo.inImageRuntimeCode()) {
-      return null;
+      return System.getProperty("enso.user.dir");


You set enso.user.dir with

commandAndArgs.add("-Denso.user.dir=" + originalCwdOrNull);

meaning that it can be -Denso.user.dir=null. And then when you get the property here, doesn't it return the "null" string?

4e6

Except for my comment about the enso.user.dir it's good to go.

JaroslavTulach · 2025-06-16T15:51:01Z

engine/runner/src/main/java/org/enso/runner/Main.java

      throws IOException, InterruptedException {
    var useJNI = true;
    var commandAndArgs = new ArrayList<String>();
+    if (originalCwdOrNull != null) {


Only set enso.user.dir when originalCwdOrNull is non-null. The problem mentioned here cannot happen, @4e6, I hope.

hubertp · 2025-06-17T12:29:42Z

The only drawback of this change is that

Picked up JAVA_TOOL_OPTIONS: ...

is now being printed always. AFAICT _JAVA_OPTIONS suffered from the same disease and it can't be suppressed.

JaroslavTulach · 2025-06-17T13:00:58Z

The only drawback of this change is that
Picked up JAVA_TOOL_OPTIONS: ...
is now being printed always.

Yes, that's correct. Is it a problem for production? I hope not.

hubertp · 2025-06-17T14:43:24Z

Yes, that's correct. Is it a problem for production? I hope not.

It's annoying. I don't know why JDK authors decided to print a debug message to stderr 🤦

Replace JAVA_OPTS variable with _JAVA_OPTIONS

7662cca

JaroslavTulach self-assigned this Jun 11, 2025

JaroslavTulach requested review from jdunkerley, radeusgd, GregoryTravis, AdRiley, 4e6, hubertp and Akirathan as code owners June 11, 2025 06:28

JaroslavTulach mentioned this pull request Jun 11, 2025

Channel connecting two JVM instances #13206

Merged

8 tasks

JaroslavTulach added 3 commits June 11, 2025 08:35

Note in a changelog

dd8f88f

Replay ENSO_JVM_OPTS with _JAVA_OPTIONS

3ad53aa

Don't concatenate _JAVA_OPTIONS on the command line

df1ee08

JaroslavTulach force-pushed the wip/jtulach/Use_JAVA_OPTIONS_13172 branch from 4ef2786 to df1ee08 Compare June 11, 2025 06:57

npx prettier makes everything prettier

966c723

Keep ENSO_JVM_OPTS variable

492857e

GregoryTravis approved these changes Jun 11, 2025

View reviewed changes

enso-bot bot mentioned this pull request Jun 12, 2025

Dual NI + JVM Mode for Loading Libraries #13172

Closed

3 tasks

_JAVA_OPTIONS are picked automatically up, no need to pass them expli…

00657ec

…citly

JaroslavTulach force-pushed the wip/jtulach/Use_JAVA_OPTIONS_13172 branch from b49fda6 to 00657ec Compare June 12, 2025 08:27

Pass the originalCwdOrNull computed in the NI to JVM via enso.user.dir

17e2200

JaroslavTulach commented Jun 12, 2025

View reviewed changes

Akirathan approved these changes Jun 13, 2025

View reviewed changes

JaroslavTulach added 2 commits June 13, 2025 12:38

JAVA_TOOL_OPTIONS is the standard name of the environment variable

80cae79

Continue to set both variables, so the extension works with old and n…

e7113ee

…ew engine

JaroslavTulach changed the title ~~Replace JAVA_OPTS variable with _JAVA_OPTIONS~~ Replace JAVA_OPTS variable with JAVA_TOOL_OPTIONS Jun 13, 2025

JaroslavTulach changed the title ~~Replace JAVA_OPTS variable with JAVA_TOOL_OPTIONS~~ Replace JAVA_OPTS variable with JAVA_TOOL_OPTIONS Jun 13, 2025

Increment micro version of our extensions

9ac5f3a

JaroslavTulach requested a review from Frizi as a code owner June 13, 2025 13:44

cargo fmt

ced5d33

jdunkerley approved these changes Jun 14, 2025

View reviewed changes

JaroslavTulach mentioned this pull request Jun 16, 2025

ENSO_JVM_OPTS changes its meaning depending on jvm mode #13279

Closed

4e6 reviewed Jun 16, 2025

View reviewed changes

4e6 approved these changes Jun 16, 2025

View reviewed changes

JaroslavTulach commented Jun 16, 2025

View reviewed changes

JaroslavTulach merged commit a3bb302 into develop Jun 16, 2025
163 of 171 checks passed

JaroslavTulach deleted the wip/jtulach/Use_JAVA_OPTIONS_13172 branch June 16, 2025 15:52

Replace JAVA_OPTS variable with JAVA_TOOL_OPTIONS #13256

Replace JAVA_OPTS variable with JAVA_TOOL_OPTIONS #13256

Uh oh!

Conversation

JaroslavTulach commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Description

Important Notes

Checklist

Uh oh!

github-actions bot commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✨ GUI Checks Results

Summary

Uh oh!

jdunkerley commented Jun 11, 2025

Uh oh!

radeusgd commented Jun 11, 2025

Uh oh!

JaroslavTulach commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JaroslavTulach Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

4e6 Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hubertp commented Jun 13, 2025

Uh oh!

Akirathan left a comment

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JaroslavTulach commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JaroslavTulach commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

4e6 Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

4e6 Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

4e6 left a comment

Choose a reason for hiding this comment

Uh oh!

JaroslavTulach Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hubertp commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JaroslavTulach commented Jun 17, 2025

Uh oh!

hubertp commented Jun 17, 2025

Uh oh!

Uh oh!

Replace `JAVA_OPTS` variable with `JAVA_TOOL_OPTIONS` #13256

Replace `JAVA_OPTS` variable with `JAVA_TOOL_OPTIONS` #13256

JaroslavTulach commented Jun 11, 2025 •

edited

Loading

github-actions bot commented Jun 11, 2025 •

edited

Loading

JaroslavTulach commented Jun 11, 2025 •

edited

Loading

JaroslavTulach Jun 12, 2025 •

edited

Loading

JaroslavTulach commented Jun 13, 2025 •

edited

Loading

JaroslavTulach commented Jun 16, 2025 •

edited

Loading

JaroslavTulach commented Jun 16, 2025 •

edited

Loading

JaroslavTulach Jun 16, 2025 •

edited

Loading

hubertp commented Jun 17, 2025 •

edited

Loading