Check undefined system properties

Many system properties are undefined in native image. Getting such
properties with System.getProperty returns null. It may result
unexpected behaviors.

This patch checks the usage of such properties at native image build, and
throw exception at run time if -R:+ReportUndefinedSystemPropertyError
option is set.

Author: ziyilin

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

@@ -24,12 +24,21 @@
  */
 package com.oracle.svm.core.jdk;
 
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Properties;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Supplier;
 
+import com.oracle.svm.core.option.RuntimeOptionKey;
+import org.graalvm.compiler.options.Option;
+import org.graalvm.compiler.serviceprovider.JavaVersionUtil;
 import org.graalvm.nativeimage.ImageInfo;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
@@ -48,25 +57,126 @@
  */
 public abstract class SystemPropertiesSupport {
 
+    public static class SystemPropertyFeatureOptions{
+        @Option(help = "Report the usage of undefined property as exception when it is not explicitly set)")//
+        public static final RuntimeOptionKey<Boolean> ReportUndefinedSystemPropertyError = new RuntimeOptionKey<>(false);
+    }
+
+    private enum ChangedType{
+        Removed, Added
+    }
+
+    private static class PropertyInfo {
+        public PropertyInfo(String name, int version, ChangedType changed) {
+            this(name, version, changed, false, null);
+        }
+
+        public PropertyInfo(String name, int version, ChangedType changed, boolean sameAsHosted){
+            this(name, version, changed, sameAsHosted, null);
+        }
+
+        public PropertyInfo(String name, int version, ChangedType changed, boolean sameAsHosted, String initValue) {
+            this.name = name;
+            this.version = version;
+            this.changed = changed;
+            this.sameAsHosted = sameAsHosted;
+            this.initValue = initValue;
+        }
+
+        public String name;
+        public int version;
+        public ChangedType changed;
+        public boolean sameAsHosted;
+        public String initValue;
+    }
+
     /** System properties that are taken from the VM hosting the image generator. */
-    private static final String[] HOSTED_PROPERTIES = {
-                    "java.version",
-                    ImageInfo.PROPERTY_IMAGE_KIND_KEY,
-                    /*
-                     * We do not support cross-compilation for now. Separator might also be cached
-                     * in other classes, so changing them would be tricky.
-                     */
-                    "line.separator", "path.separator", "file.separator",
-                    /* For our convenience for now. */
-                    "file.encoding", "sun.jnu.encoding",
-                    "java.class.version",
-                    "java.specification.name",
-                    "java.specification.vendor",
-                    "java.specification.version",
-                    "java.vm.specification.name",
-                    "java.vm.specification.vendor",
-                    "java.vm.specification.version"
-    };
+    private static final Set<String> HOSTED_PROPERTIES = new HashSet<>(Arrays.asList(
+            "java.version",
+            ImageInfo.PROPERTY_IMAGE_KIND_KEY,
+            /*
+             * We do not support cross-compilation for now. Separator might also be cached
+             * in other classes, so changing them would be tricky.
+             */
+            "line.separator", "path.separator", "file.separator",
+            /* For our convenience for now. */
+            "file.encoding", "sun.jnu.encoding",
+            "java.class.version",
+            "java.specification.name",
+            "java.specification.vendor",
+            "java.specification.version",
+            "java.vm.specification.name",
+            "java.vm.specification.vendor",
+            "java.vm.specification.version",
+            "java.runtime.version",
+            "sun.cpu.endian",
+            "sun.cpu.isalist",
+            "sun.io.unicode.encoding"));
+
+    /** Undefined properties that are not changed since JDK8.
+     * This collection is used as baseline*/
+    private static final String[] UNDEFINED_UNCHANGED_PROPERTIES_8 = {
+                    "awt.toolkit",
+                    "java.awt.graphicsenv",
+                    "java.awt.printerjob",
+                    "java.home",
+                    "sun.java.command",
+                    "sun.java.launcher",
+                    "sun.os.patch.level",
+                    "user.country",
+                    "user.language",
+                    "user.timezone"};
+
+    /** Properties are removed or added since JDK8*/
+    private static final List<PropertyInfo> CHANGED_PROPERTIES_SINCE_8 = new ArrayList<>(
+            Arrays.asList(
+                    // http://openjdk.java.net/jeps/261 http://hg.openjdk.java.net/jdk9/jdk9/hotspot/rev/c558850fac57
+                    new PropertyInfo("sun.boot.class.path", 9, ChangedType.Removed, false, ""),
+                    // http://hg.openjdk.java.net/jdk9/jdk9/jdk/rev/e336cbd8b15e
+                    new PropertyInfo("java.ext.dirs", 9, ChangedType.Removed, false, ""),
+                    new PropertyInfo("java.endorsed.dirs", 9, ChangedType.Removed, false, ""),
+                    // http://hg.openjdk.java.net/jdk9/jdk9/hotspot/rev/3b241fb72b89
+                    new PropertyInfo("java.vm.compressedOopsMode", 9, ChangedType.Added),
+                    // http://hg.openjdk.java.net/jdk9/jdk9/hotspot/rev/39c579b50006
+                    new PropertyInfo("jdk.debug", 9, ChangedType.Added),
+                    // https://openjdk.java.net/jeps/322
+                    new PropertyInfo("java.version.date", 10, ChangedType.Added, true),
+                    new PropertyInfo("java.vendor.version", 10, ChangedType.Added, true),
+                    // https://github.com/openjdk/jdk/commit/d4941f14af150fb81db7cff5394192637be701dd
+                    new PropertyInfo("file.encoding.pkg", 11, ChangedType.Removed, true)
+            )
+    );
+
+    /** Properties can be initiated at build time and are available at build time's JDK version */
+    private static final List<PropertyInfo> CUR_VERSION_INIT_PROPERTIES = new ArrayList<>();
+
+    /** Undefined properties for JDK version got from JavaVersionUtil.JAVA_SPEC */
+    private static final Set<String> UNDEFINED_PROPERTIES = ConcurrentHashMap.newKeySet();
+
+    static {
+        UNDEFINED_PROPERTIES.addAll(Arrays.asList(UNDEFINED_UNCHANGED_PROPERTIES_8));
+
+        for (PropertyInfo propertyInfo : CHANGED_PROPERTIES_SINCE_8) {
+            // Add properties introduced at current and lower JDK versions
+            if (JavaVersionUtil.JAVA_SPEC >= propertyInfo.version && propertyInfo.changed == ChangedType.Added) {
+                addProperty(propertyInfo);
+            }
+            // Add back properties that are removed in higher JDK version
+            if (JavaVersionUtil.JAVA_SPEC < propertyInfo.version && propertyInfo.changed == ChangedType.Removed) {
+                addProperty(propertyInfo);
+            }
+        }
+    }
+
+    private static void addProperty(PropertyInfo propertyInfo) {
+        if (!propertyInfo.sameAsHosted && propertyInfo.initValue == null) {
+            UNDEFINED_PROPERTIES.add(propertyInfo.name);
+        } else if (propertyInfo.sameAsHosted) {
+            HOSTED_PROPERTIES.add(propertyInfo.name);
+        } else {
+            CUR_VERSION_INIT_PROPERTIES.add(propertyInfo);
+        }
+    }
 
     /** System properties that are lazily computed at run time on first access. */
     private final Map<String, Supplier<String>> lazyRuntimeValues;
@@ -95,9 +205,10 @@ protected SystemPropertiesSupport() {
         initializeProperty("java.vendor.url", "https://www.graalvm.org/");
 
         initializeProperty("java.class.path", "");
-        initializeProperty("java.endorsed.dirs", "");
-        initializeProperty("java.ext.dirs", "");
-        initializeProperty("java.library.path", "");
+        initializeProperty("java.runtime.name", "Substrate VM Runtime Environment");
+        initializeProperty("sun.management.compiler", "GraalVM Compiler");
+        initializeProperty("java.vendor.url.bug", "https://github.com/oracle/graal/issues");
+        initializeProperty("java.vm.info", "static mode");
         initializeProperty("sun.arch.data.model", Integer.toString(ConfigurationValues.getTarget().wordJavaKind.getBitCount()));
 
         String targetName = System.getProperty("svm.targetName");
@@ -107,6 +218,10 @@ protected SystemPropertiesSupport() {
 
         initializeProperty(ImageInfo.PROPERTY_IMAGE_CODE_KEY, ImageInfo.PROPERTY_IMAGE_CODE_VALUE_RUNTIME);
 
+        for(PropertyInfo propertyInfo: CUR_VERSION_INIT_PROPERTIES){
+            initializeProperty(propertyInfo.name, propertyInfo.initValue);
+        }
+
         lazyRuntimeValues = new HashMap<>();
         lazyRuntimeValues.put("user.name", this::userName);
         lazyRuntimeValues.put("user.home", this::userHome);
@@ -141,7 +256,15 @@ public Properties getProperties() {
 
     protected String getProperty(String key) {
         initializeLazyValue(key);
-        return properties.getProperty(key);
+        String ret = properties.getProperty(key);
+        if (ret == null && isUndefined(key) && SystemPropertyFeatureOptions.ReportUndefinedSystemPropertyError.getValue()) {
+            throw new UndefinedSystemPropertyException("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 isUndefined(String key) {
+        return UNDEFINED_PROPERTIES.contains(key);
     }
 
     public void setProperties(Properties props) {

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

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c)  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.core.jdk;
+
+public class UndefinedSystemPropertyException extends RuntimeException{
+    public UndefinedSystemPropertyException(String message){
+        super(message);
+    }
+}

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

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c)  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 undefined 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.isUndefined(propertyKey)) {
+                        systemPropertyCalls.add("Undefined property: " + propertyKey + " is used at " + b.getCode().asStackTraceElement(b.bci()));
+                    }
+                }
+                return false;
+            }
+        });
+    }
+}