quit/cleanup related changes

rename BrowserQuitException to JumpToTopLevelException for more general use
refactor quit to separate cleanup action and implement GNU R semantics more closely

com.oracle.truffle.r.engine/src/com/oracle/truffle/r/engine/REngine.java

@@ -58,7 +58,7 @@ import com.oracle.truffle.r.nodes.control.NextException;
 import com.oracle.truffle.r.nodes.function.PromiseHelperNode;
 import com.oracle.truffle.r.nodes.instrumentation.RInstrumentation;
 import com.oracle.truffle.r.runtime.ArgumentsSignature;
-import com.oracle.truffle.r.runtime.BrowserQuitException;
+import com.oracle.truffle.r.runtime.JumpToTopLevelException;
 import com.oracle.truffle.r.runtime.FastROptions;
 import com.oracle.truffle.r.runtime.RArguments;
 import com.oracle.truffle.r.runtime.RCaller;
@@ -249,7 +249,7 @@ final class REngine implements Engine, Engine.Timings {
             return lastValue;
         } catch (ReturnException ex) {
             return ex.getResult();
-        } catch (DebugExitException | BrowserQuitException e) {
+        } catch (DebugExitException | JumpToTopLevelException e) {
             throw e;
         } catch (RError e) {
             // RError prints the correct result on the console during construction
@@ -324,7 +324,7 @@ final class REngine implements Engine, Engine.Timings {
                 return lastValue;
             } catch (ReturnException ex) {
                 return ex.getResult();
-            } catch (DebugExitException | BrowserQuitException e) {
+            } catch (DebugExitException | JumpToTopLevelException e) {
                 throw e;
             } catch (RError e) {
                 // TODO normal error reporting is done by the runtime
@@ -510,7 +510,7 @@ final class REngine implements Engine, Engine.Timings {
                     // there can be an outer loop
                     throw cfe;
                 }
-            } catch (DebugExitException | BrowserQuitException e) {
+            } catch (DebugExitException | JumpToTopLevelException e) {
                 CompilerDirectives.transferToInterpreter();
                 throw e;
             } catch (Throwable e) {

com.oracle.truffle.r.engine/src/com/oracle/truffle/r/engine/shell/RCommand.java

@@ -39,7 +39,7 @@ import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.api.vm.PolyglotEngine;
 import com.oracle.truffle.r.engine.TruffleRLanguage;
 import com.oracle.truffle.r.nodes.builtin.base.Quit;
-import com.oracle.truffle.r.runtime.BrowserQuitException;
+import com.oracle.truffle.r.runtime.JumpToTopLevelException;
 import com.oracle.truffle.r.runtime.RCmdOptions;
 import com.oracle.truffle.r.runtime.RInternalError;
 import com.oracle.truffle.r.runtime.RRuntime;
@@ -228,7 +228,7 @@ public class RCommand {
                              * them explicitly
                              */
                             Throwable cause = e.getCause();
-                            if (cause instanceof BrowserQuitException) {
+                            if (cause instanceof JumpToTopLevelException) {
                                 // drop through to continue REPL
                             } else if (cause instanceof DebugExitException) {
                                 throw (RuntimeException) cause;
@@ -255,7 +255,7 @@ public class RCommand {
                     // interrupted by ctrl-c
                 }
             }
-        } catch (BrowserQuitException e) {
+        } catch (JumpToTopLevelException e) {
             // can happen if user profile invokes browser (unlikely but possible)
         } catch (EOFException ex) {
             try {

com.oracle.truffle.r.native/fficall/src/jni/Rdynload_fastr.c

@@ -5,7 +5,7 @@
  *
  * Copyright (c) 1995-2012, The R Core Team
  * Copyright (c) 2003, The R Foundation
- * Copyright (c) 2014, 2015, Oracle and/or its affiliates
+ * Copyright (c) 2014, 2016, Oracle and/or its affiliates
  *
  * All rights reserved.
  */

com.oracle.truffle.r.native/fficall/src/jni/Rembedded.c

@@ -155,7 +155,7 @@ char *R_HomeDir(void) {
 	jmethodID R_HomeDirMethodID = checkGetMethodID(jniEnv, CallRFFIHelperClass, "R_HomeDir", "()Ljava/lang/String;", 1);
 	jstring homeDir = (*jniEnv)->CallStaticObjectMethod(jniEnv, CallRFFIHelperClass, R_HomeDirMethodID);
 	const char *homeDirChars = stringToChars(jniEnv, homeDir);
-	return homeDirChars;
+	return (char *)homeDirChars;
 }
 
 void R_SaveGlobalEnvToFile(const char *f) {
@@ -279,7 +279,9 @@ void uR_Busy(int x) {
 }
 
 void uR_CleanUp(SA_TYPE x, int y, int z) {
-	unimplemented("R_CleanUp");
+	JNIEnv *jniEnv = getEnv();
+	jmethodID methodID = checkGetMethodID(jniEnv, CallRFFIHelperClass, "R_CleanUp", "(III)V", 1);
+	(*jniEnv)->CallStaticVoidMethod(jniEnv, CallRFFIHelperClass, methodID, x, y, z);
 }
 
 int uR_ShowFiles(int a, const char **b, const char **c,
@@ -404,6 +406,11 @@ JNIEXPORT jstring JNICALL Java_com_oracle_truffle_r_runtime_ffi_jnr_JNI_1REmbed_
 	return result;
 }
 
+JNIEXPORT void JNICALL Java_com_oracle_truffle_r_runtime_ffi_jnr_JNI_1REmbed_nativeCleanUp(JNIEnv *jniEnv, jclass c, jint x, jint y, jint z) {
+	(*ptr_R_CleanUp)(x, y, z);
+}
+
+
 void uR_PolledEvents(void) {
 	unimplemented("R_PolledEvents");
 }

com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/Quit.java

 /*
- * Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ * This material is distributed under the GNU General Public License
+ * Version 2. You may review the terms of this license at
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
- * 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.
+ * Copyright (c) 1995, 1996, 1997  Robert Gentleman and Ross Ihaka
+ * Copyright (c) 1995-2014, The R Core Team
+ * Copyright (c) 2002-2008, The R Foundation
+ * Copyright (c) 2013, 2016, Oracle and/or its affiliates
  *
- * 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.
+ * All rights reserved.
  */
 package com.oracle.truffle.r.nodes.builtin.base;
 
@@ -31,11 +21,13 @@ import com.oracle.truffle.r.nodes.builtin.CastBuilder;
 import com.oracle.truffle.r.nodes.builtin.RBuiltinNode;
 import com.oracle.truffle.r.nodes.builtin.helpers.BrowserInteractNode;
 import com.oracle.truffle.r.runtime.RBuiltin;
+import com.oracle.truffle.r.runtime.RCleanUp;
 import com.oracle.truffle.r.runtime.RError;
+import com.oracle.truffle.r.runtime.RInternalError;
+import com.oracle.truffle.r.runtime.RRuntime;
+import com.oracle.truffle.r.runtime.RStartParams;
 import com.oracle.truffle.r.runtime.RStartParams.SA_TYPE;
 import com.oracle.truffle.r.runtime.RVisibility;
-import com.oracle.truffle.r.runtime.Utils;
-import com.oracle.truffle.r.runtime.context.ConsoleHandler;
 import com.oracle.truffle.r.runtime.context.RContext;
 import com.oracle.truffle.r.runtime.data.RNull;
 import com.oracle.truffle.r.runtime.data.model.RAbstractStringVector;
@@ -43,17 +35,15 @@ import com.oracle.truffle.r.runtime.data.model.RAbstractStringVector;
 @RBuiltin(name = "quit", visibility = RVisibility.OFF, kind = INTERNAL, parameterNames = {"save", "status", "runLast"})
 public abstract class Quit extends RBuiltinNode {
 
-    private static final String[] SAVE_VALUES = new String[]{"yes", "no", "ask", "default"};
-
     @Override
     protected void createCasts(CastBuilder casts) {
         casts.toInteger(1);
     }
 
-    private void checkSaveValue(String save) throws RError {
-        for (String saveValue : SAVE_VALUES) {
+    private SA_TYPE checkSaveValue(String save) throws RError {
+        for (String saveValue : SA_TYPE.SAVE_VALUES) {
             if (saveValue.equals(save)) {
-                return;
+                return SA_TYPE.fromString(save);
             }
         }
         throw RError.error(this, RError.Message.QUIT_SAVE);
@@ -61,75 +51,34 @@ public abstract class Quit extends RBuiltinNode {
 
     @Specialization
     @TruffleBoundary
-    protected Object doQuit(RAbstractStringVector saveArg, int status, byte runLast) {
+    protected Object doQuit(RAbstractStringVector saveArg, final int status, final byte runLastIn) {
         if (BrowserInteractNode.inBrowser()) {
             RError.warning(this, RError.Message.BROWSER_QUIT);
-            return null;
+            return RNull.instance;
         }
         String save = saveArg.getDataAt(0);
-        checkSaveValue(save);
-        // Quit does not divert its output to sink
-        ConsoleHandler consoleHandler = RContext.getInstance().getConsoleHandler();
-        if (save.equals("default")) {
-            if (RContext.getInstance().getStartParams().getSaveAction() == SA_TYPE.NOSAVE) {
-                save = "no";
-            } else {
-                if (consoleHandler.isInteractive()) {
-                    save = "ask";
-                } else {
-                    // TODO options must be set, check
-                }
-            }
+        RStartParams.SA_TYPE ask = checkSaveValue(save);
+        if (ask == SA_TYPE.SAVEASK && !RContext.getInstance().getConsoleHandler().isInteractive()) {
+            RError.warning(this, RError.Message.QUIT_ASK_INTERACTIVE);
         }
-        boolean doSave = false;
-        if (save.equals("ask")) {
-            W: while (true) {
-                consoleHandler.setPrompt("");
-                consoleHandler.print("Save workspace image? [y/n/c]: ");
-                String response = consoleHandler.readLine();
-                if (response == null) {
-                    throw Utils.exit(status);
-                }
-                if (response.length() == 0) {
-                    continue;
-                }
-                switch (response.charAt(0)) {
-                    case 'c':
-                        consoleHandler.setPrompt("> ");
-                        return RNull.instance;
-                    case 'y':
-                        doSave = true;
-                        break W;
-                    case 'n':
-                        doSave = false;
-                        break W;
-                    default:
-                        continue;
-                }
-            }
-        }
-
-        if (doSave) {
-            /*
-             * we do not have an efficient way to tell if the global environment is "dirty", so we
-             * save always
-             */
-            RContext.getEngine().checkAndRunStartupShutdownFunction("sys.save.image", new String[]{"\".RData\""});
-            RContext.getInstance().getConsoleHandler().flushHistory();
+        if (status == RRuntime.INT_NA) {
+            RError.warning(this, RError.Message.QUIT_INVALID_STATUS);
         }
-        if (runLast != 0) {
-            RContext.getEngine().checkAndRunStartupShutdownFunction(".Last");
-            // TODO errors should return to prompt if interactive
-            RContext.getEngine().checkAndRunStartupShutdownFunction(".Last.sys");
+        byte runLast = runLastIn;
+        if (runLast == RRuntime.LOGICAL_NA) {
+            RError.warning(this, RError.Message.QUIT_INVALID_RUNLAST);
+            runLast = RRuntime.LOGICAL_FALSE;
         }
-        // destroy the context inside exit() method as it still needs to access it
-        Utils.exit(status);
-        return null;
+        RCleanUp.cleanUp(ask, status, RRuntime.fromLogical(runLast));
+        throw RInternalError.shouldNotReachHere("cleanup returned");
     }
 
     @SuppressWarnings("unused")
     @Fallback
     protected Object doQuit(Object saveArg, Object status, Object runLast) {
+        if (RRuntime.asString(saveArg) == null) {
+            throw RError.error(this, RError.Message.QUIT_ASK);
+        }
         throw RError.error(this, RError.Message.INVALID_OR_UNIMPLEMENTED_ARGUMENTS);
     }
 

com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/fastr/FastRThrowIt.java

@@ -25,7 +25,7 @@ package com.oracle.truffle.r.nodes.builtin.fastr;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.r.nodes.builtin.RBuiltinNode;
-import com.oracle.truffle.r.runtime.BrowserQuitException;
+import com.oracle.truffle.r.runtime.JumpToTopLevelException;
 import com.oracle.truffle.r.runtime.RBuiltin;
 import com.oracle.truffle.r.runtime.RBuiltinKind;
 import com.oracle.truffle.r.runtime.RError;
@@ -55,7 +55,7 @@ public abstract class FastRThrowIt extends RBuiltinNode {
                 throw new Utils.DebugExitException();
             case "Q":
             case "BRQ":
-                throw new BrowserQuitException();
+                throw new JumpToTopLevelException();
             default:
                 throw RError.error(this, RError.Message.GENERIC, "unknown case: " + name);
         }

com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/helpers/BrowserInteractNode.java

@@ -28,7 +28,7 @@ import com.oracle.truffle.api.frame.MaterializedFrame;
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.r.nodes.builtin.base.Quit;
-import com.oracle.truffle.r.runtime.BrowserQuitException;
+import com.oracle.truffle.r.runtime.JumpToTopLevelException;
 import com.oracle.truffle.r.runtime.RArguments;
 import com.oracle.truffle.r.runtime.RRuntime;
 import com.oracle.truffle.r.runtime.RSrcref;
@@ -109,7 +109,7 @@ public abstract class BrowserInteractNode extends RNode {
                         exitMode = FINISH;
                         break LW;
                     case "Q":
-                        throw new BrowserQuitException();
+                        throw new JumpToTopLevelException();
                     case "where": {
                         if (RArguments.getDepth(mFrame) > 1) {
                             Object stack = Utils.createTraceback(0);

com.oracle.truffle.r.nodes/src/com/oracle/truffle/r/nodes/function/FunctionDefinitionNode.java

@@ -49,7 +49,7 @@ import com.oracle.truffle.r.nodes.control.BreakException;
 import com.oracle.truffle.r.nodes.control.NextException;
 import com.oracle.truffle.r.nodes.instrumentation.RInstrumentation;
 import com.oracle.truffle.r.runtime.ArgumentsSignature;
-import com.oracle.truffle.r.runtime.BrowserQuitException;
+import com.oracle.truffle.r.runtime.JumpToTopLevelException;
 import com.oracle.truffle.r.runtime.FunctionUID;
 import com.oracle.truffle.r.runtime.RArguments;
 import com.oracle.truffle.r.runtime.RArguments.DispatchArgs;
@@ -280,7 +280,7 @@ public final class FunctionDefinitionNode extends RRootNode implements RSyntaxNo
         } catch (RError e) {
             CompilerDirectives.transferToInterpreter();
             throw e;
-        } catch (DebugExitException | BrowserQuitException e) {
+        } catch (DebugExitException | JumpToTopLevelException e) {
             /*
              * These relate to the debugging support. exitHandlers must be suppressed and the
              * exceptions must pass through unchanged; they are not errors

com.oracle.truffle.r.runtime.ffi/src/com/oracle/truffle/r/runtime/ffi/jnr/CallRFFIHelper.java

@@ -27,12 +27,14 @@ import java.nio.charset.StandardCharsets;
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.r.runtime.RArguments;
 import com.oracle.truffle.r.runtime.RCaller;
+import com.oracle.truffle.r.runtime.RCleanUp;
 import com.oracle.truffle.r.runtime.REnvVars;
 import com.oracle.truffle.r.runtime.RError;
 import com.oracle.truffle.r.runtime.RErrorHandling;
 import com.oracle.truffle.r.runtime.RInternalError;
 import com.oracle.truffle.r.runtime.RRuntime;
 import com.oracle.truffle.r.runtime.RType;
+import com.oracle.truffle.r.runtime.RStartParams.SA_TYPE;
 import com.oracle.truffle.r.runtime.context.Engine.ParseException;
 import com.oracle.truffle.r.runtime.context.RContext;
 import com.oracle.truffle.r.runtime.data.RAttributable;
@@ -733,6 +735,11 @@ public class CallRFFIHelper {
         return REnvVars.rHome();
     }
 
+    @SuppressWarnings("unused")
+    private static void R_CleanUp(int sa, int status, int runlast) {
+        RCleanUp.stdCleanUp(SA_TYPE.values()[sa], status, runlast != 0);
+    }
+
     // Checkstyle: resume method name check
 
     public static Object validate(Object x) {

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/BrowserQuitException.java → com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/JumpToTopLevelException.java

 /*
- * Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2016, 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
@@ -23,9 +23,10 @@
 package com.oracle.truffle.r.runtime;
 
 /**
- * Thrown in response to the "Q" command in the browser.
+ * Thrown whenever the system wants to return to the top level, e.g. "Q" in browser, "c" in the
+ * {@code quit} builtin.
  */
-public class BrowserQuitException extends RuntimeException {
+public class JumpToTopLevelException extends RuntimeException {
 
     private static final long serialVersionUID = 1L;
 

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RError.java

@@ -673,6 +673,9 @@ public final class RError extends RuntimeException {
         BROWSER_QUIT("cannot quit from browser"),
         QUIT_ASK("one of \"yes\", \"no\", \"ask\" or \"default\" expected."),
         QUIT_SAVE("unrecognized value of 'save'"),
+        QUIT_ASK_INTERACTIVE("save=\"ask\" in non-interactive use: command-line default will be used"),
+        QUIT_INVALID_STATUS("invalid 'status', 0 assumed"),
+        QUIT_INVALID_RUNLAST("invalid 'runLast', FALSE assumed"),
         ENVIRONMENTS_COERCE("environments cannot be coerced to other types"),
         CLOSURE_COERCE("cannot coerce type 'closure' to vector of type 'integer'");
 

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RStartParams.java

@@ -30,13 +30,34 @@ import com.oracle.truffle.r.runtime.context.RContext;
 public class RStartParams {
 
     public enum SA_TYPE {
-        NORESTORE,
-        RESTORE,
-        DEFAULT,
-        NOSAVE,
-        SAVE,
-        SAVEASK,
-        SUICIDE
+        NORESTORE(null),
+        RESTORE(null),
+        DEFAULT("default"),
+        NOSAVE("no"),
+        SAVE("yes"),
+        SAVEASK("ask"),
+        SUICIDE(null);
+
+        private String userName;
+
+        private SA_TYPE(String userName) {
+            this.userName = userName;
+        }
+
+        public static final String[] SAVE_VALUES = new String[]{"yes", "no", "ask", "default"};
+
+        public String getUserName() {
+            return userName;
+        }
+
+        public static SA_TYPE fromString(String s) {
+            for (SA_TYPE t : values()) {
+                if (t.userName != null && t.userName.equals(s)) {
+                    return t;
+                }
+            }
+            return null;
+        }
     }
 
     private boolean quiet;

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/ffi/CallRFFI.java

 /*
- * Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2014, 2016, 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

com.oracle.truffle.r.test.native/embedded/src/main.c

@@ -124,7 +124,7 @@ int main(int argc, char **argv) {
    Rstart Rp = &rp;
    R_DefParamsFunc defp = (R_DefParamsFunc) dlsym(handle, "R_DefParams");
    (*defp)(Rp);
-   Rp->SaveAction = SA_NOSAVE;
+   Rp->SaveAction = SA_SAVEASK;
    R_SetParamsFunc setp = (R_SetParamsFunc) dlsym(handle, "R_SetParams");
    (*setp)(Rp);
    ptr_stdR_CleanUp = ptr_R_CleanUp;

mx.fastr/copyrights/overrides

@@ -149,6 +149,7 @@ com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/L
 com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/LoadSaveFunctions.java,gnu_r_gentleman_ihaka.copyright
 com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/Merge.java,gnu_r_gentleman_ihaka2.copyright
 com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/Order.java,gnu_r_gentleman_ihaka.copyright
+com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/Quit.java,gnu_r_gentleman_ihaka.copyright
 com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/Rank.java,gnu_r_gentleman_ihaka.copyright
 com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/Prod.java,purdue.copyright
 com.oracle.truffle.r.nodes.builtin/src/com/oracle/truffle/r/nodes/builtin/base/Rank.java,gnu_r_gentleman_ihaka.copyright
@@ -189,6 +190,7 @@ com.oracle.truffle.r.nodes/src/com/oracle/truffle/r/nodes/unary/IsFactorNode.jav
 com.oracle.truffle.r.parser/src/com/oracle/truffle/r/parser/R.g,purdue.copyright
 com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RSrcref.java,gnu_r.copyright
 com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RStartParams.java,gnu_r.copyright
+com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RCleanUp.java,gnu_r_gentleman_ihaka2.copyright
 com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/data/RTypedValue.java,gnu_r_gentleman_ihaka.copyright
 com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/ffi/DLL.java,gnu_r.copyright
 com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/gnur/SEXPTYPE.java,gnu_r.copyright