bench/rmi/Main.java

/*
 * Copyright 2000-2005 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

/*
 *
 */

package bench.rmi;

import bench.ConfigFormatException;
import bench.Harness;
import bench.HtmlReporter;
import bench.Reporter;
import bench.TextReporter;
import bench.XmlReporter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.rmi.RemoteException;
import java.rmi.RMISecurityManager;
import java.rmi.registry.LocateRegistry;
import java.rmi.registry.Registry;
import java.rmi.server.RemoteObject;
import java.util.Timer;
import java.util.TimerTask;

/*
 * RMI/Serialization benchmark tests.
 */
public class Main {

    /**
     * RMI-specific benchmark harness.
     */
    static class RMIHarness extends Harness {
	/**
	 * Construct new RMI benchmark harness.
	 */
	RMIHarness(InputStream in) throws IOException, ConfigFormatException {
	    super(in);
	}

	/**
	 * Cleanup both client and server side in between each benchmark.
	 */
	protected void cleanup() {
	    System.gc();
	    if (Main.runmode == CLIENT) {
		try {
		    Main.server.gc();
		} catch (Exception e) {
		    System.err.println("Warning: server gc failed: " + e);
		}
	    }
	}
    }

    static final String CONFFILE = "/bench/rmi/config";
    static final String VERSION = "1.3";
    static final String REGNAME = "server";

    static final int SAMEVM = 0;
    static final int CLIENT = 1;
    static final int SERVER = 2;

    static final int TEXT = 0;
    static final int HTML = 1;
    static final int XML = 2;

    static boolean verbose;
    static boolean list;
    static boolean exitOnTimer;
    static int testDurationSeconds;
    static volatile boolean exitRequested;
    static Timer timer;
    static int format = TEXT;
    static int runmode;
    static InputStream confstr;
    static OutputStream repstr;
    static String host;
    static int port;
    static RMIHarness harness;
    static Reporter reporter;
    static BenchServer server;
    static BenchServerImpl serverImpl;

    /**
     * Returns reference to benchmark server.
     */
    public static BenchServer getBenchServer() {
	return server;
    }

    /**
     * Prints help message.
     */
    static void usage() {
        PrintStream p = System.err;
        p.println("\nUsage: java -jar rmibench.jar [-options]");
        p.println("\nwhere options are:");
        p.println("  -h                   print this message");
        p.println("  -v                   verbose mode");
        p.println("  -l                   list configuration file");
        p.println("  -t <num hours>       repeat benchmarks for specified number of hours");
        p.println("  -o <file>            specify output file");
        p.println("  -c <file>            specify (non-default) " +
		"configuration file");
        p.println("  -html                format output as html " +
		"(default is text)");
        p.println("  -xml                 format output as xml");
	p.println("  -client <host:port>  run benchmark client using server " +
		"on specified host/port");
	p.println("  -server <port>       run benchmark server on given port");
    }

    /**
     * Print error message and exit.
     */
    static void die(String mesg) {
	System.err.println(mesg);
	System.exit(1);
    }

    /**
     * Stop server and exit.
     */
    public static void exit() {
	switch (runmode) {
	    case CLIENT:
		if (server != null) {
		    try {
			server.terminate(0);
		    } catch (RemoteException re) {
			// ignore
		    }
		}
	    default:
		System.exit(0);
	}
    }

    /**
     * Benchmark mainline.
     */
    public static void main(String[] args) {
	setupSecurity();
	parseArgs(args);
	setupStreams();
	if (list) {
	    listConfig();
	} else {
	    setupServer();
	    if (runmode != SERVER) {
		setupHarness();
		setupReporter();
		if (exitOnTimer) {
		    setupTimer(testDurationSeconds);
		    while (true) {
			runBenchmarks();
			if (exitRequested) {
			    exit();
			}
		    }
		} else {
		    runBenchmarks();
		    exit();
		}
	    }
	}
    }

    /**
     * Parse command-line arguments.
     */
    static void parseArgs(String[] args) {
	for (int i = 0; i < args.length; i++) {
	    if (args[i].equals("-h")) {
		usage();
		System.exit(0);
	    } else if (args[i].equals("-v")) {
		verbose = true;
	    } else if (args[i].equals("-l")) {
		list = true;
	    } else if (args[i].equals("-t")) {
		if (++i >= args.length)
		    die("Error: no timeout value specified");
		try {
		    exitOnTimer = true;
		    testDurationSeconds = Integer.parseInt(args[i]) * 3600;
		} catch (Exception e) {
		    die("Error: unable to determine timeout value");
		}
	    } else if (args[i].equals("-o")) {
		if (++i >= args.length)
		    die("Error: no output file specified");
		try {
		    repstr = new FileOutputStream(args[i]);
		} catch (IOException e) {
		    die("Error: unable to open \"" + args[i] + "\"");
		}
	    } else if (args[i].equals("-c")) {
		if (++i >= args.length)
		    die("Error: no config file specified");
		try {
		    confstr = new FileInputStream(args[i]);
		} catch (IOException e) {
		    die("Error: unable to open \"" + args[i] + "\"");
		}
	    } else if (args[i].equals("-html")) {
		if (format != TEXT)
		    die("Error: conflicting formats");
		format = HTML;
	    } else if (args[i].equals("-xml")) {
		if (format != TEXT)
		    die("Error: conflicting formats");
		format = XML;
	    } else if (args[i].equals("-client")) {
		if (runmode == CLIENT)
		    die("Error: multiple -client options");
		if (runmode == SERVER)
		    die("Error: -client and -server options conflict");
		if (++i >= args.length)
		    die("Error: -client missing host/port");
		try {
		    int sepi = args[i].indexOf(':');
		    host = args[i].substring(0, sepi);
		    port = Integer.parseInt(args[i].substring(sepi + 1));
		} catch (Exception e) {
		    die("Error: illegal host/port specified for -client");
		}
		runmode = CLIENT;
	    } else if (args[i].equals("-server")) {
		if (runmode == CLIENT)
		    die("Error: -client and -server options conflict");
		if (runmode == SERVER)
		    die("Error: multiple -server options");
		if (++i >= args.length)
		    die("Error: -server missing port");
		try {
		    port = Integer.parseInt(args[i]);
		} catch (Exception e) {
		    die("Error: illegal port specified for -server");
		}
		runmode = SERVER;
	    } else {
		System.err.println("Illegal option: \"" + args[i] + "\"");
		usage();
		System.exit(1);
	    }
	}
    }

    /**
     * Set up security manager and policy, if not set already.
     */
    static void setupSecurity() {
	if (System.getSecurityManager() != null)
	    return;

	/* As of 1.4, it is too late to set the security policy
	 * file at this point so these line have been commented out.
	 */
	//System.setProperty("java.security.policy",
	//	Main.class.getResource("/bench/rmi/policy.all").toString());
	System.setSecurityManager(new RMISecurityManager());
    }

    /**
     * Set up configuration file and report streams, if not set already.
     */
    static void setupStreams() {
	if (repstr == null)
	    repstr = System.out;
	if (confstr == null)
	    confstr = (new Main()).getClass().getResourceAsStream(CONFFILE);
	if (confstr == null)
	    die("Error: unable to find default config file");
    }

    /**
     * Print contents of configuration file to selected output stream.
     */
    static void listConfig() {
	try {
	    byte[] buf = new byte[256];
	    int len;
	    while ((len = confstr.read(buf)) != -1)
		repstr.write(buf, 0, len);
	} catch (IOException e) {
	    die("Error: failed to list config file");
	}
    }

    /**
     * Setup benchmark server.
     */
    static void setupServer() {
	switch (runmode) {
	    case SAMEVM:
		try {
		    serverImpl = new BenchServerImpl();
		    server = (BenchServer) RemoteObject.toStub(serverImpl);
		} catch (Exception e) {
		    die("Error: failed to create local server: " + e);
		}
		if (verbose)
		    System.out.println("Benchmark server created locally");
		break;

	    case CLIENT:
		try {
		    Registry reg = LocateRegistry.getRegistry(host, port);
		    server = (BenchServer) reg.lookup(REGNAME);
		} catch (Exception e) {
		    die("Error: failed to connect to server: " + e);
		}
		if (server == null) {
		    die("Error: server not found");
		}
		if (verbose) {
		    System.out.println("Connected to benchmark server on " +
			    host + ":" + port);
		}
		break;

	    case SERVER:
		try {
		    Registry reg = LocateRegistry.createRegistry(port);
		    serverImpl = new BenchServerImpl();
		    reg.bind(REGNAME, serverImpl);
		} catch (Exception e) {
		    die("Error: failed to initialize server: " + e);
		}
		if (verbose) {
		    System.out.println("Benchmark server started on port " +
			    port);
		}
		break;

	    default:
		throw new InternalError("illegal runmode");
	}
    }

    /**
     * Set up the timer to end the test.
     *
     * @param delay the amount of delay, in seconds, before requesting
     * the process exit
     */
    static void setupTimer(int delay) {
	timer = new Timer(true);
        timer.schedule(
            new TimerTask() {
                public void run() {
                    exitRequested = true;
                }
            },
            delay * 1000);
    }

    /**
     * Set up benchmark harness.
     */
    static void setupHarness() {
        try {
            harness = new RMIHarness(confstr);
        } catch (ConfigFormatException e) {
            String errmsg = e.getMessage();
            if (errmsg != null) {
		die("Error parsing config file: " + errmsg);
	    } else {
                die("Error: illegal config file syntax");
	    }
        } catch (IOException e) {
	    die("Error: failed to read config file");
        }
    }

    /**
     * Setup benchmark reporter.
     */
    static void setupReporter() {
        String title = "RMI Benchmark, v" + VERSION;
	switch (format) {
	    case TEXT:
		reporter = new TextReporter(repstr, title);
		break;

	    case HTML:
		reporter = new HtmlReporter(repstr, title);
		break;

	    case XML:
		reporter = new XmlReporter(repstr, title);
		break;

	    default:
		die("Error: unrecognized format type");
	}
    }

    /**
     * Run benchmarks.
     */
    static void runBenchmarks() {
        harness.runBenchmarks(reporter, verbose);
    }
}