/* * Copyright (c) 1998, 2014, 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. * * 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. */ import java.io.*; import java.rmi.*; import java.rmi.activation.*; import java.rmi.registry.*; import java.util.concurrent.TimeoutException; /** * Utility class that creates an instance of rmid with a policy * file of name TestParams.defaultPolicy. * * Activation groups should run with the same security manager as the * test. */ public class RMID extends JavaVM { // TODO: adjust these based on the timeout factor // such as jcov.sleep.multiplier; see start(long) method. // Also consider the test.timeout.factor property (a float). private static final long TIMEOUT_SHUTDOWN_MS = 60_000L; private static final long TIMEOUT_DESTROY_MS = 10_000L; private static final long STARTTIME_MS = 15_000L; private static final long POLLTIME_MS = 100L; private static final String SYSTEM_NAME = ActivationSystem.class.getName(); // "java.rmi.activation.ActivationSystem" public static String MANAGER_OPTION="-Djava.security.manager="; /** Test port for rmid */ private final int port; /** Initial log name */ protected static String log = "log"; /** rmid's logfile directory; currently must be "." */ protected static String LOGDIR = "."; private static void mesg(Object mesg) { System.err.println("RMID: " + mesg.toString()); } /** make test options and arguments */ private static String makeOptions(boolean debugExec) { String options = " -Dsun.rmi.server.activation.debugExec=" + debugExec; // + //" -Djava.compiler= "; // if test params set, want to propagate them if (!TestParams.testSrc.equals("")) { options += " -Dtest.src=" + TestParams.testSrc + " "; } //if (!TestParams.testClasses.equals("")) { // options += " -Dtest.classes=" + TestParams.testClasses + " "; //} options += " -Dtest.classes=" + TestParams.testClasses //; + " -Djava.rmi.server.logLevel=v "; // + // " -Djava.security.debug=all "; // Set execTimeout to 60 sec (default is 30 sec) // to avoid spurious timeouts on slow machines. options += " -Dsun.rmi.activation.execTimeout=60000"; return options; } private static String makeArgs(boolean includePortArg, int port) { String propagateManager = null; // rmid will run with a security manager set, but no policy // file - it should not need one. if (System.getSecurityManager() == null) { propagateManager = MANAGER_OPTION + TestParams.defaultSecurityManager; } else { propagateManager = MANAGER_OPTION + System.getSecurityManager().getClass().getName(); } // getAbsolutePath requires permission to read user.dir String args = " -log " + (new File(LOGDIR, log)).getAbsolutePath(); if (includePortArg) { args += " -port " + port; } // + // " -C-Djava.compiler= "; // if test params set, want to propagate them if (!TestParams.testSrc.equals("")) { args += " -C-Dtest.src=" + TestParams.testSrc; } if (!TestParams.testClasses.equals("")) { args += " -C-Dtest.classes=" + TestParams.testClasses; } if (!TestParams.testJavaOpts.equals("")) { for (String a : TestParams.testJavaOpts.split(" +")) { args += " -C" + a; } } if (!TestParams.testVmOpts.equals("")) { for (String a : TestParams.testVmOpts.split(" +")) { args += " -C" + a; } } args += " -C-Djava.rmi.server.useCodebaseOnly=false "; args += " " + getCodeCoverageArgs(); return args; } /** * Routine that creates an rmid that will run with or without a * policy file. */ public static RMID createRMID() { return createRMID(System.out, System.err, true, true, TestLibrary.getUnusedRandomPort()); } public static RMID createRMID(OutputStream out, OutputStream err, boolean debugExec) { return createRMID(out, err, debugExec, true, TestLibrary.getUnusedRandomPort()); } public static RMID createRMID(OutputStream out, OutputStream err, boolean debugExec, boolean includePortArg, int port) { String options = makeOptions(debugExec); String args = makeArgs(includePortArg, port); RMID rmid = new RMID("sun.rmi.server.Activation", options, args, out, err, port); rmid.setPolicyFile(TestParams.defaultRmidPolicy); return rmid; } /** * Private constructor. RMID instances should be created * using the static factory methods. */ private RMID(String classname, String options, String args, OutputStream out, OutputStream err, int port) { super(classname, options, args, out, err); this.port = port; } /** * Removes rmid's log file directory. */ public static void removeLog() { File f = new File(LOGDIR, log); if (f.exists()) { mesg("Removing rmid's old log file."); String[] files = f.list(); if (files != null) { for (int i=0; i deadline) { TestLibrary.bomb("Failed to start rmid, giving up after " + (System.currentTimeMillis() - startTime) + "ms.", null); } } } /** * Destroys rmid and restarts it. Note that this does NOT clean up * the log file, because it stores information about restartable * and activatable objects that must be carried over to the new * rmid instance. */ public void restart() throws IOException { destroy(); start(); } /** * Ask rmid to shutdown gracefully using a remote method call. * catch any errors that might occur from rmid not being present * at time of shutdown invocation. If the remote call is * successful, wait for the process to terminate. Return true * if the process terminated, otherwise return false. */ private boolean shutdown() throws InterruptedException { mesg("shutdown()"); long startTime = System.currentTimeMillis(); ActivationSystem system = lookupSystem(port); if (system == null) { mesg("lookupSystem() returned null after " + (System.currentTimeMillis() - startTime) + "ms."); return false; } try { mesg("ActivationSystem.shutdown()"); system.shutdown(); } catch (Exception e) { mesg("Caught exception from ActivationSystem.shutdown():"); e.printStackTrace(); } try { waitFor(TIMEOUT_SHUTDOWN_MS); mesg("Shutdown successful after " + (System.currentTimeMillis() - startTime) + "ms."); return true; } catch (TimeoutException ex) { mesg("Shutdown timed out after " + (System.currentTimeMillis() - startTime) + "ms:"); ex.printStackTrace(); return false; } } /** * Ask rmid to shutdown gracefully but then destroy the rmid * process if it does not exit by itself. This method only works * if rmid is a child process of the current VM. */ public void destroy() { if (vm == null) { throw new IllegalStateException("can't wait for RMID that isn't running"); } long startTime = System.currentTimeMillis(); // First, attempt graceful shutdown of the activation system. try { if (! shutdown()) { // Graceful shutdown failed, use Process.destroy(). mesg("Destroying RMID process."); vm.destroy(); try { waitFor(TIMEOUT_DESTROY_MS); mesg("Destroy successful after " + (System.currentTimeMillis() - startTime) + "ms."); } catch (TimeoutException ex) { mesg("Destroy timed out, giving up after " + (System.currentTimeMillis() - startTime) + "ms:"); ex.printStackTrace(); } } } catch (InterruptedException ie) { mesg("Shutdown/destroy interrupted, giving up at " + (System.currentTimeMillis() - startTime) + "ms."); ie.printStackTrace(); Thread.currentThread().interrupt(); return; } vm = null; } /** * Shuts down rmid and then removes its log file. */ public void cleanup() { destroy(); RMID.removeLog(); } /** * Gets the port on which this rmid is listening. */ public int getPort() { return port; } }