8298266: "java.home property not set" error in Graal when sun.awt.fontconfig java property is set on Windows #11559

AlexanderScherbatiy · 2022-12-07T13:20:10Z

Environment:
GraalVM 22.3.0 with jdk 19, Windows OS.

Description:
Create a native image of Swing application using GraalVM and run it with -Dsun.awt.fontconfig=fontconfig.properties.src java property.
java.lang.Error: java.home property not set error is thrown.

For more details see oracle/graal#4875.

Solution:
The error is thrown by the code from FontConfiguration.findFontConfigFile() method.
GraalVM does not set java.home property, that is why the java.lang.Error: java.home property not set is thrown.
FontConfiguration.findFontConfigFile() method compares java.home property to null before checking user provided sun.awt.fontconfig java property.

The proposed fix swaps the order of java.home and sun.awt.fontconfig properties checking to avoid using java.home property in case sun.awt.fontconfig is set.

Steps to reproduce:

Download graal 22.3.0 jdk 19 for Windows from GraalVM Community Edition 22.3.0 page.
Install native-image

graalvm-ce-java19-22.3.0\bin\gu.cmd install native-image

Create and compile SwingSample.java sample

import java.awt.*;
import javax.swing.*;

public class SwingSample {
    public static void main(String[] args) throws Exception {
        SwingUtilities.invokeAndWait(() -> {

            JFrame frame = new JFrame("Hello World");

            JButton button = new JButton("Hello");
            button.addActionListener(e -> {
                System.out.printf("Hello, World!%n");
            });

            JPanel panel = new JPanel(new FlowLayout());
            panel.add(button);

            frame.add(panel);
            frame.setSize(400, 300);
            frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
            frame.setVisible(true);
        });
    }
}

Run native-image-agent to generate configuration files

graalvm-ce-java19-22.3.0\bin\java.cmd -agentlib:native-image-agent=config-output-dir=conf-dir SwingSample

Copy graalvm-ce-java19-22.3.0\lib\fontconfig.properties.src file to the sample dir
Generate native image with configuration files and -Djava.awt.headless=false , -Dsun.awt.fontconfig=fontconfig.properties.src java properties

call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64"
graalvm-ce-java19-22.3.0\bin\native-image.cmd --no-fallback -Djava.awt.headless=false -Dsun.awt.fontconfig=fontconfig.properties.src -H:ResourceConfigurationFiles=conf-dir/resource-config.json -H:SerializationConfigurationFiles=conf-dir/serialization-config.json -H:ReflectionConfigurationFiles=conf-dir/reflect-config.json -H:JNIConfigurationFiles=conf-dir/jni-config.json SwingSample

Run the native image with -Dsun.awt.fontconfig=fontconfig.properties.src java property.

swingsample.exe  -Dsun.awt.fontconfig=fontconfig.properties.src

Exception in thread "main" java.lang.reflect.InvocationTargetException
        at java.desktop@19.0.1/java.awt.EventQueue.invokeAndWait(EventQueue.java:1371)
        at java.desktop@19.0.1/java.awt.EventQueue.invokeAndWait(EventQueue.java:1346)
        at java.desktop@19.0.1/javax.swing.SwingUtilities.invokeAndWait(SwingUtilities.java:1480)
        at SwingSample.main(SwingSample.java:7)
Caused by: java.lang.Error: java.home property not set
        at java.desktop@19.0.1/sun.awt.FontConfiguration.findFontConfigFile(FontConfiguration.java:180)
        at java.desktop@19.0.1/sun.awt.FontConfiguration.<init>(FontConfiguration.java:97)
        at java.desktop@19.0.1/sun.awt.windows.WFontConfiguration.<init>(WFontConfiguration.java:41)

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)

Issue

JDK-8298266: "java.home property not set" error in Graal when sun.awt.fontconfig java property is set on Windows

Reviewers

Sergey Bylokhov (@mrserb - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/11559/head:pull/11559
$ git checkout pull/11559

Update a local copy of the PR:
$ git checkout pull/11559
$ git pull https://git.openjdk.org/jdk pull/11559/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11559

View PR using the GUI difftool:
$ git pr show -t 11559

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/11559.diff

…ava property is set on Windows

bridgekeeper · 2022-12-07T13:21:11Z

👋 Welcome back alexsch! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2022-12-07T13:23:38Z

@AlexanderScherbatiy The following label will be automatically applied to this pull request:

client

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

mlbridge · 2022-12-07T13:26:50Z

Webrevs

01: Full - Incremental (f882a0eb)
00: Full (f50dc866)

mrserb · 2022-12-19T08:59:57Z

I can reproduce the bug and assume that this change will fix that exception. But after this change, we will skip initialization of the "javaLib" if the user config was passed, and as a result, we will skip initialization of the fallback fonts by the getInstalledFallbackFonts. I do not know should if fallback fonts are used if the user explicitly set config or not.

AlexanderScherbatiy · 2022-12-22T10:59:19Z

Could you review the updated fix? The javaLib variable is initialized even userConfigFile is not null.

openjdk · 2022-12-23T07:27:08Z

@AlexanderScherbatiy This change is no longer ready for integration - check the PR body for details.

prrace · 2022-12-23T18:04:18Z

/reviewers 2

prrace · 2022-12-23T18:04:37Z

Why is it not set ? That seems wrong.

openjdk · 2022-12-23T18:05:17Z

@prrace
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

AlexanderScherbatiy · 2022-12-23T18:41:41Z

There is the Java system properties are inconsistent between traditional JDK and native image issue in Graal: oracle/graal#2835

With comment: oracle/graal#2835 (comment)

We are still not setting the java.home system property at image run time by default, and do not plan to change that. Because there is just no "JDK home directory" around at image run time, so setting java.home to, for example, the directory where the native image is located in is misleading - files that might be expected to be in that directory are not there.

prrace · 2022-12-23T18:53:20Z

There is the Java system properties are inconsistent between traditional JDK and native image issue in Graal: oracle/graal#2835

With comment: oracle/graal#2835 (comment)

We are still not setting the java.home system property at image run time by default, and do not plan to change that. Because there is just no "JDK home directory" around at image run time, so setting java.home to, for example, the directory where the native image is located in is misleading - files that might be expected to be in that directory are not there.

Surely that's graal's problem to solve.
This is a standard system property, it is an error if it is not set correctly.
Also sun.awt.config is not a supported documented property. It was put there for debugging.
If user code is relying on that (I'm not sure if that is being implied) then it is on shaky ground.
We could remove that at any time without notice.

AlanBateman · 2022-12-29T06:37:16Z

The table in System.getProperties() lists the standard system properties. java.home is not optional. It's not hard to find code that reads the value of this property and it would be a major compatibility issue to change java.home to be optional.

AlexanderScherbatiy · 2022-12-30T09:59:10Z

Graal uses a substitutor which replaces FontConfiguration.findFontConfigFile() method to empty on Linux.
This does not work on Windows because it requires to read logical fonts from fontconfig.properties file.

The idea of the fix was to allow to use sun.awt.fontconfig property in Graal.
If sun.awt.fontconfig property is not a supported documented property then may be it is better to put the fontconfig.properties file as a resource during a native image generation and read it when the application is executed.

prrace · 2023-01-03T19:24:43Z

FYI here's an almost 9 year old bug report where I make clear the unsupported nature of that property. https://bugs.openjdk.org/browse/JDK-8038987

Seems this PR should be withdrawn and the bug report closed as external or not an issue.

mrserb · 2023-01-06T00:49:58Z

If this property is not optional why do we have a null check for it? Can that check be removed as a part of refactoring?

prrace · 2023-01-06T20:42:38Z

If this property is not optional why do we have a null check for it? Can that check be removed as a part of refactoring?

It is much better to have an error thrown which explains the problem rather than a random NPE or similar right afterwards.
This behaviour has been there since at least JDK 1.3 (2000) when the file was first created as sun/awt/FontProperties.java. It may even have existed in some other location before then, but I can't tell that from SCCS per-file history.

mrserb · 2023-01-06T22:54:30Z

It is much better to have an error thrown which explains the problem rather than a random NPE or similar right afterwards.

But I assume we should have a test somewhere that validates that this option is not null = "is not optional"?
I make a quick search of code where we read the conf files, and it seems:
https://github.com/search?q=%22java.home%22+repo%3Aopenjdk%2Fjdk+path%3Asrc%2Fjava.desktop%2F+language%3AJava+language%3AJava&type=Code&ref=advsearch&l=Java&l=Java

The Sound - throw an exception in one place, but ignores the null in another place
The Fontconfig - throw an exception in FcFontConfiguration.java, but fallback to the empty code in SunFontManager.java
The Swing ignores the null property
The metal pipeline fallback to the empty path
The a11y code just read it as is.
The printers code in PSPrinterJob ignores the null

We have an opportunity to clean up all that code.

prrace · 2023-01-17T20:51:36Z

But I assume we should have a test somewhere that validates that this option is not null = "is not optional"?

Maybe core libs could add such a test.

The link doesn't work for me but I expect I'd need to look at each of those cases to understand what they are doing.

It doesn't change that the reason for this proposed change isn't valid.
We probably should remove that debugging property to make it clear.

AlanBateman · 2023-01-18T07:22:02Z

Maybe core libs could add such a test.

It is tested by conformance tests but a test could be added to the OpenJDK jtreg tests if needed.

'java.home property not set' error in Graal when sun.awt.fontconfig j…

f50dc86

…ava property is set on Windows

openjdk bot added the rfr Pull request is ready for review label Dec 7, 2022

AlexanderScherbatiy changed the title ~~8298266: 'java.home property not set' error in Graal when sun.awt.fontconfig java property is set on Windows~~ 8298266: "java.home property not set" error in Graal when sun.awt.fontconfig java property is set on Windows Dec 7, 2022

openjdk bot added the client client-libs-dev@openjdk.org label Dec 7, 2022

Initialize javaLib when a user fontconfig file is set

f882a0e

mrserb approved these changes Dec 23, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Dec 23, 2022

openjdk bot removed the ready Pull request is ready to be integrated label Dec 23, 2022

AlexanderScherbatiy closed this Jan 20, 2023

AlexanderScherbatiy mentioned this pull request Jun 7, 2023

Register JNI and Reflection classes for AWT/Swing on Linux oracle/graal#5870

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8298266: "java.home property not set" error in Graal when sun.awt.fontconfig java property is set on Windows #11559

8298266: "java.home property not set" error in Graal when sun.awt.fontconfig java property is set on Windows #11559

AlexanderScherbatiy commented Dec 7, 2022 •

edited by openjdk bot

Loading

bridgekeeper bot commented Dec 7, 2022

openjdk bot commented Dec 7, 2022

mlbridge bot commented Dec 7, 2022 •

edited

Loading

mrserb commented Dec 19, 2022

AlexanderScherbatiy commented Dec 22, 2022

openjdk bot commented Dec 23, 2022 •

edited

Loading

prrace commented Dec 23, 2022

prrace commented Dec 23, 2022

openjdk bot commented Dec 23, 2022

AlexanderScherbatiy commented Dec 23, 2022

prrace commented Dec 23, 2022

AlanBateman commented Dec 29, 2022

AlexanderScherbatiy commented Dec 30, 2022

prrace commented Jan 3, 2023

mrserb commented Jan 6, 2023

prrace commented Jan 6, 2023

mrserb commented Jan 6, 2023 •

edited

Loading

prrace commented Jan 17, 2023

AlanBateman commented Jan 18, 2023

8298266: "java.home property not set" error in Graal when sun.awt.fontconfig java property is set on Windows #11559

8298266: "java.home property not set" error in Graal when sun.awt.fontconfig java property is set on Windows #11559

Conversation

AlexanderScherbatiy commented Dec 7, 2022 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Dec 7, 2022

openjdk bot commented Dec 7, 2022

mlbridge bot commented Dec 7, 2022 • edited Loading

Webrevs

mrserb commented Dec 19, 2022

AlexanderScherbatiy commented Dec 22, 2022

openjdk bot commented Dec 23, 2022 • edited Loading

prrace commented Dec 23, 2022

prrace commented Dec 23, 2022

openjdk bot commented Dec 23, 2022

AlexanderScherbatiy commented Dec 23, 2022

prrace commented Dec 23, 2022

AlanBateman commented Dec 29, 2022

AlexanderScherbatiy commented Dec 30, 2022

prrace commented Jan 3, 2023

mrserb commented Jan 6, 2023

prrace commented Jan 6, 2023

mrserb commented Jan 6, 2023 • edited Loading

prrace commented Jan 17, 2023

AlanBateman commented Jan 18, 2023

AlexanderScherbatiy commented Dec 7, 2022 •

edited by openjdk bot

Loading

mlbridge bot commented Dec 7, 2022 •

edited

Loading

openjdk bot commented Dec 23, 2022 •

edited

Loading

mrserb commented Jan 6, 2023 •

edited

Loading