[GR-14379] Use GraalVM SDK launchers.

PullRequest: fastr/2322

Author: steve-s

com.oracle.truffle.r.launcher/src/com/oracle/truffle/r/launcher/RMain.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2020, 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
@@ -70,14 +70,6 @@ private static int runROrRScript(String command, String[] args, InputStream inSt
         }
     }
 
-    /**
-     * Tells this R launcher to not process the {@code --jvm} and {@code --jvm.help}. Normally such
-     * arguments are processed by the native launcher, but if there is no native launcher, we need
-     * to explicitly process them in this class since the Truffle launcher does not count on this
-     * eventuality.
-     */
-    private static final boolean ignoreJvmArguments = "true".equals(System.getProperty("fastr.internal.ignorejvmargs"));
-
     protected final InputStream inStream;
     protected final OutputStream outStream;
     protected final OutputStream errStream;
@@ -95,7 +87,6 @@ private static int runROrRScript(String command, String[] args, InputStream inSt
     private RCmdOptions options;
     private ConsoleHandler consoleHandler;
     private String[] rArguments;
-    private boolean useJVM;
     private Context preparedContext; // to transfer between launch and execute when !launcherMode
 
     private RMain(boolean launcherMode, InputStream inStream, OutputStream outStream, OutputStream errStream, int timeoutSecs) {
@@ -135,15 +126,6 @@ protected List<String> preprocessArguments(List<String> arguments, Map<String, S
 
         List<String> unrecognizedArgs = new ArrayList<>();
         for (int i = 0; i < arguments.size(); i++) {
-            if (!ignoreJvmArguments && ("--jvm.help".equals(arguments.get(i)) || "--vm.help".equals(arguments.get(i)))) {
-                // This condition should be removed when FastR always ships with native launcher
-                // that handles this option for us
-                printJvmHelp();
-                throw exit();
-            } else if (!ignoreJvmArguments && "--jvm".equals(arguments.get(i))) {
-                useJVM = true;
-            } else
-
             if (!recognizedArgsIndices[i]) {
                 unrecognizedArgs.add(arguments.get(i));
             }
@@ -176,9 +158,6 @@ protected void launch(Builder contextBuilderIn) {
         }
         this.consoleHandler = ConsoleHandler.createConsoleHandler(options, null, inStream, outStream);
         Builder contextBuilder = contextBuilderIn;
-        if (!ignoreJvmArguments && !useJVM) {
-            contextBuilder.allowHostClassLookup(null);
-        }
 
         boolean isLLVMBackEnd = false;
         boolean debugLLVMLibs = false;
@@ -331,67 +310,4 @@ public synchronized Throwable fillInStackTrace() {
             return this;
         }
     }
-
-    // The following code is copied from org.graalvm.launcher.Launcher and it should be removed
-    // when the R launcher always ships native version that handles --vm.help for us.
-
-    private static void printJvmHelp() {
-        System.out.println("JVM options:");
-        printOption("--vm.classpath <...>", "A " + File.pathSeparator + " separated list of classpath entries that will be added to the JVM's classpath");
-        printOption("--vm.D<name>=<value>", "Set a system property");
-        printOption("--vm.esa", "Enable system assertions");
-        printOption("--vm.ea[:<packagename>...|:<classname>]", "Enable assertions with specified granularity");
-        printOption("--vm.agentlib:<libname>[=<options>]", "Load native agent library <libname>");
-        printOption("--vm.agentpath:<pathname>[=<options>]", "Load native agent library by full pathname");
-        printOption("--vm.javaagent:<jarpath>[=<options>]", "Load Java programming language agent");
-        printOption("--vm.Xbootclasspath/a:<...>", "A " + File.pathSeparator + " separated list of classpath entries that will be added to the JVM's boot classpath");
-        printOption("--vm.Xmx<size>", "Set maximum Java heap size");
-        printOption("--vm.Xms<size>", "Set initial Java heap size");
-        printOption("--vm.Xss<size>", "Set java thread stack size");
-    }
-
-    private static void printOption(String option, String description, int indentation) {
-        String indent = spaces(indentation);
-        String desc = wrap(description != null ? description : "");
-        String nl = System.lineSeparator();
-        String[] descLines = desc.split(nl);
-        int optionWidth = 45;
-        if (option.length() >= optionWidth && description != null) {
-            System.out.println(indent + option + nl + indent + spaces(optionWidth) + descLines[0]);
-        } else {
-            System.out.println(indent + option + spaces(optionWidth - option.length()) + descLines[0]);
-        }
-        for (int i = 1; i < descLines.length; i++) {
-            System.out.println(indent + spaces(optionWidth) + descLines[i]);
-        }
-    }
-
-    static void printOption(String option, String description) {
-        printOption(option, description, 2);
-    }
-
-    private static String spaces(int length) {
-        return new String(new char[length]).replace('\0', ' ');
-    }
-
-    private static String wrap(String s) {
-        final int width = 120;
-        StringBuilder sb = new StringBuilder(s);
-        int cursor = 0;
-        while (cursor + width < sb.length()) {
-            int i = sb.lastIndexOf(" ", cursor + width);
-            if (i == -1 || i < cursor) {
-                i = sb.indexOf(" ", cursor + width);
-            }
-            if (i != -1) {
-                sb.replace(i, i + 1, System.lineSeparator());
-                cursor = i;
-            } else {
-                break;
-            }
-        }
-        return sb.toString();
-    }
-
-    // End of copied code
 }

com.oracle.truffle.r.native/run/Makefile

@@ -75,7 +75,7 @@ rcmds: $(FASTR_BIN_DIR)/R
 $(FASTR_BIN_DIR)/R: Makefile R.sh Rscript.sh Rscript_exec.sh Rclasspath.sh
 	cp -r $(BIN_FILES) $(FASTR_BIN_DIR)
 	# Note: in the GraalVM release support distribution we override exec/R and Rscript
-	# with scripts R_legacy and Rscript_legacy from com.oracle.truffle.r.release
+	# with scripts R_launcher and Rscript_launcher from com.oracle.truffle.r.release
 	# overide bin/exec/R
 	cp R.sh $(FASTR_BIN_DIR)/exec/R
 	# override bin/Rscript

com.oracle.truffle.r.native/run/Rscript.sh

@@ -27,7 +27,7 @@
 # Rscript is a script in the bin directory that simply invokes bin/execRextras/Rscript
 # N.B. This can't be in bin/exec as then it is treated as a sub-architecture
 # NOTE: this is used only in the development build,
-# com.oracle.truffle.r.release/src/Rscript_legacy is used in the release
+# com.oracle.truffle.r.release/src/Rscript_launcher is used in the release
 
 source="${BASH_SOURCE[0]}"
 while [ -h "$source" ] ; do source="$(readlink "$source")"; done

com.oracle.truffle.r.native/run/Rscript_exec.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 #
-# Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2015, 2020, 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
@@ -25,7 +25,7 @@
 # Startup FastR (Rscript) using the mx tool (development)
 # This is exec'ed by the (generic) Rscript script in the parent directory.
 # NOTE: this is used only in the development build,
-# com.oracle.truffle.r.release/src/Rscript_legacy is used in the release
+# com.oracle.truffle.r.release/src/Rscript_launcher is used in the release
 
 source="${BASH_SOURCE[0]}"
 while [ -h "$source" ] ; do source="$(readlink "$source")"; done

com.oracle.truffle.r.native/run/fastr_tools/install_r_native_image

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2017, 2020, 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
@@ -39,19 +39,15 @@ location="$( cd -P "$( dirname "$source" )" && pwd )"
 fastr_home="$( dirname "$location" )"
 
 silent=0
-uninstall=0
 verbose=0
 for arg in "$@"; do
     if [[ $arg == "--silent" ]]; then
         silent=1
     elif [[ $arg == "--verbose" ]]; then
         verbose=1
-    elif [[ $arg == "uninstall" ]]; then
-        uninstall=1
     elif [[ $arg == "--help" ]]; then
-        echo "Usage: install_r_native_image [uninstall] [--silent]"
-        echo "When 'uninstall' argument is not present: builds and installs native image of the R runtime."
-        echo "When 'uninstall' argument is present: uninstalls previously installed native image of the R runtime."
+        echo "Usage: install_r_native_image [--silent]"
+        echo "Builds and installs native image of the R runtime."
         echo "Use the --silent option to turn off the confirmation when installing."
         echo "Use the --verbose option to turn on detailed logging."
 	exit 0
@@ -64,20 +60,10 @@ function log {
     fi
 }
 
-if [[ $uninstall -eq 1 ]]; then
-    echo "Uninstalling native image of R runtime..."
-    log "current working directory: ${PWD}"
-    log "relative FastR home: ${fastr_home}"
-    mv "$fastr_home/bin/exec_R.backup" "$fastr_home/bin/exec/R"
-    mv "$fastr_home/bin/Rscript.backup" "$fastr_home/bin/Rscript"
-    rm -f "$fastr_home/bin/RorRscriptDispatcher"
-    echo "Native image of R runtime uninstalled"
-    exit 0
-fi
-
+echo "Note: this script is deprecated use: \$GRAALVM_HOME/bin/gu rebuild-images R"
 if [[ $silent -eq 0 ]]; then
-    echo "This script is going to build a native image of the R runtime and update the R launchers to use that image as the default, i.e., when '--jvm' option is not used. You can uninstall the native image by running this script with the 'uninstall' argument. Run this script with '--help' for more details."
-    echo "The build takes several minutes and needs a minimum of 6GB of RAM and 150MB of free disk space. The computer may lag during the build."
+    echo "This script is going to build a native image of the R runtime and update the R launchers to use that image as the default, i.e., when '--jvm' option is not used."
+    echo "The build takes several minutes and needs a minimum of 8GB of RAM and 200MB of free disk space. The computer may lag during the build."
     read -p "Are you sure you want to build and install the native image of the R runtime? (Yy/Nn) " -n 1 -r
     echo
     if [[ ! $REPLY =~ ^[Yy]$ ]]; then
@@ -91,10 +77,8 @@ cd "$fastr_home/bin"
 
 graalvm_home_bin="../../../../bin"
 native_image=$graalvm_home_bin/native-image
-launcher_relative_home="jre/languages/R/bin/RMain"
 if [ ! -f "$native_image" ]; then
     graalvm_home_bin="../../../bin"
-    launcher_relative_home="languages/R/bin/RMain"
     native_image=$graalvm_home_bin/native-image
 fi
 if [ ! -f "$native_image" ]; then
@@ -104,50 +88,6 @@ fi
 graalvm_home="$( dirname "${graalvm_home_bin}" )"
 log "current working directory: ${PWD}"
 log "relative graalvm_home: ${graalvm_home}"
-log "launcher relative home: ${launcher_relative_home}"
 log "relative FastR home: ${fastr_home}"
 
-fastr_launcher_ni_args=(
-    --no-fallback
-    --initialize-at-build-time
-    -H:+ReportExceptionStackTraces
-    -cp "${fastr_home}/fastr-launcher.jar:${fastr_home}/../../lib/graalvm/launcher-common.jar"
-    --language:R
-    --language:llvm
-    --tool:all
-    -Dorg.graalvm.version=19.0.3
-    -H:-ParseRuntimeOptions
-    -Dorg.graalvm.launcher.relative.language.home=bin/RMain
-    -Dorg.graalvm.launcher.classpath=${fastr_home}/../../lib/graalvm/launcher-common.jar:${fastr_home}/fastr-launcher.jar
-    -Dorg.graalvm.launcher.relative.home=${launcher_relative_home}
-	-Dfastr.awt.support=false
-    -H:Class=com.oracle.truffle.r.launcher.RMain
-)
-if [[ $verbose -eq 1 ]]; then
-  fastr_launcher_ni_args+=('--verbose')
-fi
-
-log "Running:" $native_image "${fastr_launcher_ni_args[@]}" -H:Name=RMain
-$native_image "${fastr_launcher_ni_args[@]}" -H:Name=RMain
-
-log "Creating backup of the R and Rscript launchers"
-cp "exec/R" "exec_R.backup"
-cp "Rscript" "Rscript.backup"
-
-log "Patching the R and Rscript launchers to dispatch to the generated native image"
-sed -e '/^## REMOVE FOR NATIVE IMAGE: BEGIN/,/^## REMOVE FOR NATIVE IMAGE: END/d;' "exec_R.backup" | \
-sed -e 's|^exec "${fastr_home}/../../bin/java" .*|exec "$R_HOME/bin/RMain" R ${FASTR_INTERNAL_ARGS[@]} "$@"|' > "exec/R"
-sed -e '/^## REMOVE FOR NATIVE IMAGE: BEGIN/,/^## REMOVE FOR NATIVE IMAGE: END/d;' "Rscript.backup" | \
-sed -e 's|^exec "${fastr_home}/../../bin/java" .*|exec "$R_HOME/bin/RMain" Rscript ${FASTR_INTERNAL_ARGS[@]} "$@"|' > "Rscript"
-
-if [ "$R_INSTALL_NATIVE_IMAGE_VERY_VERBOSE" = "true" ]; then
-  echo "${PWD}exec/R contents:"
-  echo "*****************\n"
-  cat exec/R
-  echo "*****************\n"
-  echo "${PWD}/Rscript contents:"
-  cat Rscript
-  echo "*****************\n"
-  echo "ls -la ${PWD}"
-  ls -la ${PWD}
-fi
+"$native_image" --macro:RMain-launcher

com.oracle.truffle.r.release/src/R_launcher

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) 2018, 2020, 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 3 only, as
+# published by the Free Software Foundation.
+#
+# 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 3 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
+# 3 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.
+#
+
+# This script is deployed as
+# jre/languages/R/bin/exec/R in JDK8
+# languages/R/bin/exec/R in JDK11
+# It forwards to the RMain launcher, which is a regular Graal SDK launcher
+
+source="${BASH_SOURCE[0]}"
+while [ -h "$source" ] ; do
+    prev_source="$source"
+    source="$(readlink "$source")";
+    if [[ "$source" != /* ]]; then
+        # if the link was relative, it was relative to where it came from
+        dir="$( cd -P "$( dirname "$prev_source" )" && pwd )"
+        source="$dir/$source"
+    fi
+done
+location="$( cd -P "$( dirname "$source" )" && pwd )"
+fastr_home="$( dirname "$( dirname "${location}" )" )"
+
+exec "${fastr_home}/bin/RMain" R ${FASTR_INTERNAL_ARGS[@]} "$@"