Check incompatible system properties

Many system properties are incompatible. Report warning
for the usage of such properties at native image build and
throw exception at run time.

Author: ziyilin

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/IncompatibleSystemPropertyException.java

@@ -0,0 +1,7 @@
+package com.oracle.svm.core.jdk;
+
+public class IncompatibleSystemPropertyException extends RuntimeException{
+    public IncompatibleSystemPropertyException(String message){
+        super(message);
+    }
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/SystemPropertiesSupport.java

@@ -30,6 +30,8 @@
 import java.util.Properties;
 import java.util.function.Supplier;
 
+import com.oracle.svm.core.option.RuntimeOptionKey;
+import org.graalvm.compiler.options.Option;
 import org.graalvm.nativeimage.ImageInfo;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
@@ -48,6 +50,11 @@
  */
 public abstract class SystemPropertiesSupport {
 
+    public static class SystemPropertyFeatureOptions{
+        @Option(help = "Report the usage of incompatible property as exception when it is not explicitly set)")//
+        public static final RuntimeOptionKey<Boolean> ReportIncompatibleSystemPropertyError = new RuntimeOptionKey<>(false);
+    }
+
     /** System properties that are taken from the VM hosting the image generator. */
     private static final String[] HOSTED_PROPERTIES = {
                     "java.version",
@@ -65,7 +72,36 @@ public abstract class SystemPropertiesSupport {
                     "java.specification.version",
                     "java.vm.specification.name",
                     "java.vm.specification.vendor",
-                    "java.vm.specification.version"
+                    "java.vm.specification.version",
+                    "sun.arch.data.model"
+    };
+
+    /**
+     * System properties are unsupported by default.
+     */
+    private static final String[] INCOMPATIBLE_PROPERTIES = {
+                    "awt.toolkit",
+                    "file.encoding.pkg",
+                    "java.awt.graphicsenv",
+                    "java.awt.printerjob",
+                    "java.home",
+                    "java.library.path",
+                    "java.runtime.name",
+                    "java.runtime.version",
+                    "java.vendor.url.bug",
+                    "java.vm.info",
+                    "sun.boot.class.path",
+                    "sun.boot.library.path",
+                    "sun.cpu.endian",
+                    "sun.cpu.isalist",
+                    "sun.io.unicode.encoding",
+                    "sun.java.command",
+                    "sun.java.launcher",
+                    "sun.management.compiler",
+                    "sun.os.patch.level",
+                    "user.country",
+                    "user.language",
+                    "user.timezone"
     };
 
     /** System properties that are lazily computed at run time on first access. */
@@ -141,7 +177,20 @@ public Properties getProperties() {
 
     protected String getProperty(String key) {
         initializeLazyValue(key);
-        return properties.getProperty(key);
+        String ret = properties.getProperty(key);
+        if (ret == null && isIncompatible(key) && SystemPropertyFeatureOptions.ReportIncompatibleSystemPropertyError.getValue()) {
+            throw new IncompatibleSystemPropertyException("Java system property " + key + " is incompatible in native image. Please explicitly assign the expected value via -D" + key + "=, or avoid using this property.");
+        }
+        return ret;
+    }
+
+    public static boolean isIncompatible(String key) {
+        for (int i = 0; i < INCOMPATIBLE_PROPERTIES.length; i++) {
+            if (INCOMPATIBLE_PROPERTIES[i].equals(key)) {
+                return true;
+            }
+        }
+        return false;
     }
 
     public void setProperties(Properties props) {

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/SystemPropertyFeature.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020 Alibaba Group Holding Limited. All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.svm.hosted;
+
+import com.oracle.svm.core.annotate.AutomaticFeature;
+import com.oracle.svm.core.graal.GraalFeature;
+import com.oracle.svm.core.jdk.SystemPropertiesSupport;
+import jdk.vm.ci.meta.ResolvedJavaMethod;
+import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;
+import org.graalvm.compiler.nodes.ValueNode;
+import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext;
+import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin;
+import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins;
+import org.graalvm.compiler.phases.util.Providers;
+
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
+@AutomaticFeature
+public class SystemPropertyFeature implements GraalFeature {
+
+    private final Set<String> systemPropertyCalls = ConcurrentHashMap.newKeySet();
+
+    @Override
+    public void afterImageWrite(AfterImageWriteAccess access) {
+        if (!systemPropertyCalls.isEmpty()) {
+            StringBuilder sb = new StringBuilder("\n\nNative image incompatible system properties are used in the program:\n");
+            for (String s : systemPropertyCalls) {
+                sb.append("    ").append(s).append("\n");
+            }
+            sb.append("The returned value of calling System.getProperty with these keys will be null in native image.\n");
+            sb.append("Please make sure the expected property values are specified with -D when running the native image program or just avoid using them.\n\n");
+            System.out.println(sb.toString());
+        }
+    }
+
+    @Override
+    public void registerInvocationPlugins(Providers providers, SnippetReflectionProvider snippetReflection, InvocationPlugins invocationPlugins, boolean analysis, boolean hosted) {
+        InvocationPlugins.Registration r = new InvocationPlugins.Registration(invocationPlugins, System.class);
+        r.register1("getProperty", String.class, new InvocationPlugin() {
+            @Override
+            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode name) {
+                if (name.isConstant()) {
+                    String propertyKey = snippetReflection.asObject(String.class, name.asJavaConstant());
+                    if (SystemPropertiesSupport.isIncompatible(propertyKey)) {
+                        systemPropertyCalls.add("Incompatible property:" + propertyKey + " is used at " + b.getCode().asStackTraceElement(b.bci()));
+                    }
+                }
+                return false;
+            }
+        });
+    }
+}