[GR-10796] Add org.graalvm.nativeimage.Image API.

PullRequest: graal/1808

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/ImageInfo.java

@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2018, 2018, Oracle and/or its affiliates. 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 org.graalvm.nativeimage;
+
+/**
+ * Utility class to retrieve information about the context in which code gets executed. The provided
+ * string constants are part of the API and guaranteed to remain unchanged in future versions. This
+ * allows to use {@link System#getProperty(String)} directly with the string literals defined here
+ * thus eliminating the need to depend on this class.
+ *
+ * @since 1.0
+ */
+public final class ImageInfo {
+
+    private ImageInfo() {
+    }
+
+    /**
+     * Holds the string that is the name of the system property providing information about the
+     * context in which code is currently executing. If the property returns the string given by
+     * {@link #PROPERTY_IMAGE_CODE_VALUE_BUILDTIME} the code is executing in the context of image
+     * building (e.g. in a static initializer of a class that will be contained in the image). If
+     * the property returns the string given by {@link #PROPERTY_IMAGE_CODE_VALUE_RUNTIME} the code
+     * is executing at image runtime. Otherwise the property is not set.
+     *
+     * @since 1.0
+     */
+    public static final String PROPERTY_IMAGE_CODE_KEY = "org.graalvm.nativeimage.imagecode";
+
+    /**
+     * Holds the string that will be returned by the system property for
+     * {@link ImageInfo#PROPERTY_IMAGE_CODE_KEY} if code is executing in the context of image
+     * building (e.g. in a static initializer of class that will be contained in the image).
+     *
+     * @since 1.0
+     */
+    public static final String PROPERTY_IMAGE_CODE_VALUE_BUILDTIME = "buildtime";
+
+    /**
+     * Holds the string that will be returned by the system property for
+     * {@link ImageInfo#PROPERTY_IMAGE_CODE_KEY} if code is executing at image runtime.
+     *
+     * @since 1.0
+     */
+    public static final String PROPERTY_IMAGE_CODE_VALUE_RUNTIME = "runtime";
+
+    /**
+     * Returns true if (at the time of the call) code is executing in the context of image building
+     * or during image runtime, else false. This method will be const-folded so that it can be used
+     * to hide parts of an application that only work when running on the JVM. For example:
+     * {@code if (!ImageInfo.inImageCode()) { ... JVM specific code here ... }}
+     *
+     * @since 1.0
+     */
+    public static boolean inImageCode() {
+        return System.getProperty(PROPERTY_IMAGE_CODE_KEY) != null;
+    }
+
+    /**
+     * Returns true if (at the time of the call) code is executing at image runtime. This method
+     * will be const-folded. It can be used to hide parts of an application that only work when
+     * running as native image.
+     *
+     * @since 1.0
+     */
+    public static boolean inImageRuntimeCode() {
+        return PROPERTY_IMAGE_CODE_VALUE_RUNTIME.equals(System.getProperty(PROPERTY_IMAGE_CODE_KEY));
+    }
+
+    /**
+     * Returns true if (at the time of the call) code is executing in the context of image building
+     * (e.g. in a static initializer of class that will be contained in the image).
+     *
+     * @since 1.0
+     */
+    public static boolean inImageBuildtimeCode() {
+        return PROPERTY_IMAGE_CODE_VALUE_BUILDTIME.equals(System.getProperty(PROPERTY_IMAGE_CODE_KEY));
+    }
+}

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

@@ -29,6 +29,7 @@
 import java.util.Properties;
 import java.util.function.Supplier;
 
+import org.graalvm.nativeimage.ImageInfo;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 
@@ -72,10 +73,13 @@ protected SystemPropertiesSupport() {
         }
 
         lazyRuntimeValues = new HashMap<>();
+        lazyRuntimeValues.put("java.vm.name", () -> "Substrate VM");
         lazyRuntimeValues.put("user.name", this::userNameValue);
         lazyRuntimeValues.put("user.home", this::userHomeValue);
         lazyRuntimeValues.put("user.dir", this::userDirValue);
         lazyRuntimeValues.put("java.io.tmpdir", this::tmpdirValue);
+
+        lazyRuntimeValues.put(ImageInfo.PROPERTY_IMAGE_CODE_KEY, () -> ImageInfo.PROPERTY_IMAGE_CODE_VALUE_RUNTIME);
     }
 
     public Properties getProperties() {

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

@@ -105,6 +105,7 @@
 import org.graalvm.compiler.word.WordTypes;
 import org.graalvm.nativeimage.Feature;
 import org.graalvm.nativeimage.Feature.OnAnalysisExitAccess;
+import org.graalvm.nativeimage.ImageInfo;
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
@@ -386,6 +387,7 @@ public void run(Map<Method, CEntryPointData> entryPoints, Method mainEntryPoint,
             if (!buildStarted.compareAndSet(false, true)) {
                 throw UserError.abort("An image build has already been performed with this generator.");
             }
+            System.setProperty(ImageInfo.PROPERTY_IMAGE_CODE_KEY, ImageInfo.PROPERTY_IMAGE_CODE_VALUE_BUILDTIME);
             int maxConcurrentThreads = NativeImageOptions.getMaximumNumberOfConcurrentThreads(new OptionValues(optionProvider.getHostedValues()));
             this.imageBuildPool = createForkJoinPool(maxConcurrentThreads);
             imageBuildPool.submit(() -> {
@@ -422,6 +424,7 @@ public void run(Map<Method, CEntryPointData> entryPoints, Method mainEntryPoint,
             }
         } finally {
             shutdownPoolSafe();
+            System.clearProperty(ImageInfo.PROPERTY_IMAGE_CODE_KEY);
         }
     }
 

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/snippets/SubstrateGraphBuilderPlugins.java

@@ -68,6 +68,7 @@
 import org.graalvm.compiler.nodes.java.StoreIndexedNode;
 import org.graalvm.compiler.options.Option;
 import org.graalvm.compiler.replacements.nodes.BasicObjectCloneNode;
+import org.graalvm.nativeimage.ImageInfo;
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.RuntimeReflection;
@@ -114,6 +115,7 @@
 import jdk.vm.ci.meta.ConstantReflectionProvider;
 import jdk.vm.ci.meta.DeoptimizationAction;
 import jdk.vm.ci.meta.DeoptimizationReason;
+import jdk.vm.ci.meta.JavaConstant;
 import jdk.vm.ci.meta.JavaKind;
 import jdk.vm.ci.meta.Local;
 import jdk.vm.ci.meta.LocalVariableTable;
@@ -134,6 +136,7 @@ public static void registerInvocationPlugins(MetaAccessProvider metaAccess, Cons
 
         // register the substratevm plugins
         registerSystemPlugins(metaAccess, plugins);
+        registerImageInfoPlugins(metaAccess, plugins);
         registerProxyPlugins(snippetReflection, plugins, analysis);
         registerAtomicUpdaterPlugins(metaAccess, snippetReflection, plugins, analysis);
         registerObjectPlugins(plugins);
@@ -164,6 +167,34 @@ public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Rec
         });
     }
 
+    private static void registerImageInfoPlugins(MetaAccessProvider metaAccess, InvocationPlugins plugins) {
+        Registration proxyRegistration = new Registration(plugins, ImageInfo.class);
+        proxyRegistration.register0("inImageCode", new InvocationPlugin() {
+            /** See {@link ImageInfo#inImageCode()}. */
+            @Override
+            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver) {
+                b.push(JavaKind.Boolean, ConstantNode.forConstant(JavaConstant.TRUE, metaAccess, b.getGraph()));
+                return true;
+            }
+        });
+        proxyRegistration.register0("inImageBuildtimeCode", new InvocationPlugin() {
+            /** See {@link ImageInfo#inImageBuildtimeCode()}. */
+            @Override
+            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver) {
+                b.push(JavaKind.Boolean, ConstantNode.forConstant(JavaConstant.FALSE, metaAccess, b.getGraph()));
+                return true;
+            }
+        });
+        proxyRegistration.register0("inImageRuntimeCode", new InvocationPlugin() {
+            /** See {@link ImageInfo#inImageRuntimeCode()}. */
+            @Override
+            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver) {
+                b.push(JavaKind.Boolean, ConstantNode.forConstant(JavaConstant.TRUE, metaAccess, b.getGraph()));
+                return true;
+            }
+        });
+    }
+
     private static void registerProxyPlugins(SnippetReflectionProvider snippetReflection, InvocationPlugins plugins, boolean analysis) {
         if (analysis) {
             Registration proxyRegistration = new Registration(plugins, Proxy.class);