/*

 * Copyright 1995-2008 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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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 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.

 */

/*

 * Shared source for 'java' command line tool.

 *

 * If JAVA_ARGS is defined, then acts as a launcher for applications. For

 * instance, the JDK command line tools such as javac and javadoc (see

 * makefiles for more details) are built with this program.  Any arguments

 * prefixed with '-J' will be passed directly to the 'java' command.

 */

/*

 * One job of the launcher is to remove command line options which the

 * vm does not understand and will not process.  These options include

 * options which select which style of vm is run (e.g. -client and

 * -server) as well as options which select the data model to use.

 * Additionally, for tools which invoke an underlying vm "-J-foo"

 * options are turned into "-foo" options to the vm.  This option

 * filtering is handled in a number of places in the launcher, some of

 * it in machine-dependent code.  In this file, the function

 * CheckJVMType removes vm style options and TranslateApplicationArgs

 * removes "-J" prefixes.  On unix platforms, the

 * CreateExecutionEnvironment function from the unix java_md.c file

 * processes and removes -d<n> options.  However, in case

 * CreateExecutionEnvironment does not need to exec because

 * LD_LIBRARY_PATH is set acceptably and the data model does not need

 * to be changed, ParseArguments will screen out the redundant -d<n>

 * options and prevent them from being passed to the vm; this is done

 * by RemovableOption.

 */

#include "java.h"

/*

 * A NOTE TO DEVELOPERS: For performance reasons it is important that

 * the program image remain relatively small until after SelectVersion

 * CreateExecutionEnvironment have finished their possibly recursive

 * processing. Watch everything, but resist all temptations to use Java

 * interfaces.

 */

static jboolean printVersion = JNI_FALSE; /* print and exit */

static jboolean showVersion = JNI_FALSE;  /* print but continue */

static jboolean printUsage = JNI_FALSE;   /* print and exit*/

static jboolean printXUsage = JNI_FALSE;  /* print and exit*/

static const char *_program_name;

static const char *_launcher_name;

static jboolean _is_java_args = JNI_FALSE;

static const char *_fVersion;

static const char *_dVersion;

static jboolean _wc_enabled = JNI_FALSE;

static jint _ergo_policy = DEFAULT_POLICY;

/*

 * Entries for splash screen environment variables.

 * putenv is performed in SelectVersion. We need

 * them in memory until UnsetEnv, so they are made static

 * global instead of auto local.

 */

static char* splash_file_entry = NULL;

static char* splash_jar_entry = NULL;

/*

 * List of VM options to be specified when the VM is created.

 */

static JavaVMOption *options;

static int numOptions, maxOptions;

/*

 * Prototypes for functions internal to launcher.

 */

static void SetClassPath(const char *s);

static void SelectVersion(int argc, char **argv, char **main_class);

static jboolean ParseArguments(int *pargc, char ***pargv, char **pjarfile,

                               char **pclassname, int *pret, const char *jvmpath);

static jboolean InitializeJVM(JavaVM **pvm, JNIEnv **penv,

                              InvocationFunctions *ifn);

static jstring NewPlatformString(JNIEnv *env, char *s);

static jobjectArray NewPlatformStringArray(JNIEnv *env, char **strv, int strc);

static jclass LoadMainClass(JNIEnv *env, jboolean isJar, char *name);

static void TranslateApplicationArgs(int jargc, const char **jargv, int *pargc, char ***pargv);

static jboolean AddApplicationOptions(int cpathc, const char **cpathv);

static void SetApplicationClassPath(const char**);

static void PrintJavaVersion(JNIEnv *env, jboolean extraLF);

static void PrintUsage(JNIEnv* env, jboolean doXUsage);

static void SetPaths(int argc, char **argv);

static void DumpState();

static jboolean RemovableOption(char *option);

/* Maximum supported entries from jvm.cfg. */

#define INIT_MAX_KNOWN_VMS      10

/* Values for vmdesc.flag */

enum vmdesc_flag {

    VM_UNKNOWN = -1,

    VM_KNOWN,

    VM_ALIASED_TO,

    VM_WARN,

    VM_ERROR,

    VM_IF_SERVER_CLASS,

    VM_IGNORE

};

struct vmdesc {

    char *name;

    int flag;

    char *alias;

    char *server_class;

};

static struct vmdesc *knownVMs = NULL;

static int knownVMsCount = 0;

static int knownVMsLimit = 0;

static void GrowKnownVMs();

static int  KnownVMIndex(const char* name);

static void FreeKnownVMs();

static void ShowSplashScreen();

static jboolean IsWildCardEnabled();

#define ARG_CHECK(n, f, a) if (n < 1) { \

    JLI_ReportErrorMessage(f, a); \

    printUsage = JNI_TRUE; \

    *pret = 1; \

    return JNI_TRUE; \

}

/*

 * Running Java code in primordial thread caused many problems. We will

 * create a new thread to invoke JVM. See 6316197 for more information.

 */

static jlong threadStackSize = 0;  /* stack size of the new thread */

int JNICALL JavaMain(void * args); /* entry point                  */

typedef struct {

  int     argc;

  char ** argv;

  char *  jarfile;

  char *  classname;

  InvocationFunctions ifn;

} JavaMainArgs;

/*

 * Entry point.

 */

int

JLI_Launch(int argc, char ** argv,              /* main argc, argc */

        int jargc, const char** jargv,          /* java args */

        int appclassc, const char** appclassv,  /* app classpath */

        const char* fullversion,                /* full version defined */

        const char* dotversion,                 /* dot version defined */

        const char* pname,                      /* program name */

        const char* lname,                      /* launcher name */

        jboolean javaargs,                      /* JAVA_ARGS */

        jboolean cpwildcard,                    /* classpath wildcard*/

        jboolean javaw,                         /* windows-only javaw */

        jint ergo                               /* ergonomics class policy */

)

{

    char *jarfile = 0;

    char *classname = 0;

    char *cpath = 0;

    char *main_class = NULL;

    int ret;

    InvocationFunctions ifn;

    jlong start, end;

    char jrepath[MAXPATHLEN], jvmpath[MAXPATHLEN];

    char ** original_argv = argv;

    _fVersion = fullversion;

    _dVersion = dotversion;

    _launcher_name = lname;

    _program_name = pname;

    _is_java_args = javaargs;

    _wc_enabled = cpwildcard;

    _ergo_policy = ergo;

    InitLauncher(javaw);

    DumpState();

    /*

     * Make sure the specified version of the JRE is running.

     *

     * There are three things to note about the SelectVersion() routine:

     *  1) If the version running isn't correct, this routine doesn't

     *     return (either the correct version has been exec'd or an error

     *     was issued).

     *  2) Argc and Argv in this scope are *not* altered by this routine.

     *     It is the responsibility of subsequent code to ignore the

     *     arguments handled by this routine.

     *  3) As a side-effect, the variable "main_class" is guaranteed to

     *     be set (if it should ever be set).  This isn't exactly the

     *     poster child for structured programming, but it is a small

     *     price to pay for not processing a jar file operand twice.

     *     (Note: This side effect has been disabled.  See comment on

     *     bugid 5030265 below.)

     */

    SelectVersion(argc, argv, &main_class);

    /* copy original argv */

    JLI_TraceLauncher("Command line Args:\n");

    original_argv = (JLI_CopyArgs(argc, (const char**)argv));

    CreateExecutionEnvironment(&argc, &argv,

                               jrepath, sizeof(jrepath),

                               jvmpath, sizeof(jvmpath),

                               original_argv);

    ifn.CreateJavaVM = 0;

    ifn.GetDefaultJavaVMInitArgs = 0;

    if (JLI_IsTraceLauncher()) {

        start = CounterGet();

    }

    if (!LoadJavaVM(jvmpath, &ifn)) {

        return(6);

    }

    if (JLI_IsTraceLauncher()) {

        end   = CounterGet();

    }

    JLI_TraceLauncher("%ld micro seconds to LoadJavaVM\n",

             (long)(jint)Counter2Micros(end-start));

    ++argv;

    --argc;

    if (IsJavaArgs()) {

        /* Preprocess wrapper arguments */

        TranslateApplicationArgs(jargc, jargv, &argc, &argv);

        if (!AddApplicationOptions(appclassc, appclassv)) {

            return(1);

        }

    } else {

        /* Set default CLASSPATH */

        cpath = getenv("CLASSPATH");

        if (cpath == NULL) {

            cpath = ".";

        }

        SetClassPath(cpath);

    }

    /*

     *  Parse command line options; if the return value of

     *  ParseArguments is false, the program should exit.

     */

    if (!ParseArguments(&argc, &argv, &jarfile, &classname, &ret, jvmpath)) {

        return(ret);

    }

    /* Override class path if -jar flag was specified */

    if (jarfile != 0) {

        SetClassPath(jarfile);

    }

    /* set the -Dsun.java.command pseudo property */

    SetJavaCommandLineProp(classname, jarfile, argc, argv);

    /* Set the -Dsun.java.launcher pseudo property */

    SetJavaLauncherProp();

    /* set the -Dsun.java.launcher.* platform properties */

    SetJavaLauncherPlatformProps();

    /* Show the splash screen if needed */

    ShowSplashScreen();

    return ContinueInNewThread(&ifn, argc, argv, jarfile, classname, ret);

}

#define CHECK_EXCEPTION_NULL_LEAVE(e) \

    if ((*env)->ExceptionOccurred(env)) { \

        JLI_ReportExceptionDescription(env); \

        goto leave; \

    } \

    if ((e) == NULL) { \

        JLI_ReportErrorMessage(JNI_ERROR); \

        goto leave; \

    }

#define CHECK_EXCEPTION_LEAVE(rv) \

    if ((*env)->ExceptionOccurred(env)) { \

        JLI_ReportExceptionDescription(env); \

        ret = (rv); \

        goto leave; \

    }

int JNICALL

JavaMain(void * _args)

{

    JavaMainArgs *args = (JavaMainArgs *)_args;

    int argc = args->argc;

    char **argv = args->argv;

    char *jarfile = args->jarfile;

    char *classname = args->classname;

    InvocationFunctions ifn = args->ifn;

    JavaVM *vm = 0;

    JNIEnv *env = 0;

    jstring mainClassName;

    jclass mainClass;

    jmethodID mainID;

    jobjectArray mainArgs;

    int ret = 0;

    jlong start, end;

    /* Initialize the virtual machine */

    start = CounterGet();

    if (!InitializeJVM(&vm, &env, &ifn)) {

        JLI_ReportErrorMessage(JVM_ERROR1);

        exit(1);

    }

    if (printVersion || showVersion) {

        PrintJavaVersion(env, showVersion);

        CHECK_EXCEPTION_LEAVE(0);

        if (printVersion) {

            ret = 0;

            goto leave;

        }

    }

    /* If the user specified neither a class name nor a JAR file */

    if (printXUsage || printUsage || (jarfile == 0 && classname == 0)) {

        PrintUsage(env, printXUsage);

        CHECK_EXCEPTION_LEAVE(1);

        goto leave;

    }

    FreeKnownVMs();  /* after last possible PrintUsage() */

    if (JLI_IsTraceLauncher()) {

        end = CounterGet();

        JLI_TraceLauncher("%ld micro seconds to InitializeJVM\n",

               (long)(jint)Counter2Micros(end-start));

    }

    /* At this stage, argc/argv have the applications' arguments */

    if (JLI_IsTraceLauncher()){

        int i;

        printf("Main-Class is '%s'\n", classname ? classname : "");

        printf("Apps' argc is %d\n", argc);

        for (i=0; i < argc; i++) {

            printf("    argv[%2d] = '%s'\n", i, argv[i]);

        }

    }

    ret = 1;

    /*

     * Get the application's main class.

     *

     * See bugid 5030265.  The Main-Class name has already been parsed

     * from the manifest, but not parsed properly for UTF-8 support.

     * Hence the code here ignores the value previously extracted and

     * uses the pre-existing code to reextract the value.  This is

     * possibly an end of release cycle expedient.  However, it has

     * also been discovered that passing some character sets through

     * the environment has "strange" behavior on some variants of

     * Windows.  Hence, maybe the manifest parsing code local to the

     * launcher should never be enhanced.

     *

     * Hence, future work should either:

     *     1)   Correct the local parsing code and verify that the

     *          Main-Class attribute gets properly passed through

     *          all environments,

     *     2)   Remove the vestages of maintaining main_class through

     *          the environment (and remove these comments).

     */

    if (jarfile != 0) {

        mainClass = LoadMainClass(env, JNI_TRUE, jarfile);

    } else {

        mainClass = LoadMainClass(env, JNI_FALSE, classname);

    }

    CHECK_EXCEPTION_NULL_LEAVE(mainClass);

    /*

     * The LoadMainClass not only loads the main class, it will also ensure

     * that the main method's signature is correct, therefore further checking

     * is not required. The main method is invoked here so that extraneous java

     * stacks are not in the application stack trace.

     */

    mainID = (*env)->GetStaticMethodID(env, mainClass, "main",

                                       "([Ljava/lang/String;)V");

    CHECK_EXCEPTION_NULL_LEAVE(mainID);

    /* Build argument array */

    mainArgs = NewPlatformStringArray(env, argv, argc);

    CHECK_EXCEPTION_NULL_LEAVE(mainArgs);

    /* Invoke main method. */

    (*env)->CallStaticVoidMethod(env, mainClass, mainID, mainArgs);

    /*

     * The launcher's exit code (in the absence of calls to

     * System.exit) will be non-zero if main threw an exception.

     */

    ret = (*env)->ExceptionOccurred(env) == NULL ? 0 : 1;

leave:

    /*

     * Always detach the main thread so that it appears to have ended when

     * the application's main method exits.  This will invoke the

     * uncaught exception handler machinery if main threw an

     * exception.  An uncaught exception handler cannot change the

     * launcher's return code except by calling System.exit.

     */

    if ((*vm)->DetachCurrentThread(vm) != 0) {

        JLI_ReportErrorMessage(JVM_ERROR2);

        ret = 1;

    }

    /*

     * Wait for all non-daemon threads to end, then destroy the VM.

     * This will actually create a trivial new Java waiter thread

     * named "DestroyJavaVM", but this will be seen as a different

     * thread from the one that executed main, even though they are

     * the same C thread.  This allows mainThread.join() and

     * mainThread.isAlive() to work as expected.

     */

    (*vm)->DestroyJavaVM(vm);

    return ret;

}

/*

 * Checks the command line options to find which JVM type was

 * specified.  If no command line option was given for the JVM type,

 * the default type is used.  The environment variable

 * JDK_ALTERNATE_VM and the command line option -XXaltjvm= are also

 * checked as ways of specifying which JVM type to invoke.

 */

char *

CheckJvmType(int *pargc, char ***argv, jboolean speculative) {

    int i, argi;

    int argc;

    char **newArgv;

    int newArgvIdx = 0;

    int isVMType;

    int jvmidx = -1;

    char *jvmtype = getenv("JDK_ALTERNATE_VM");

    argc = *pargc;

    /* To make things simpler we always copy the argv array */

    newArgv = JLI_MemAlloc((argc + 1) * sizeof(char *));

    /* The program name is always present */

    newArgv[newArgvIdx++] = (*argv)[0];

    for (argi = 1; argi < argc; argi++) {

        char *arg = (*argv)[argi];

        isVMType = 0;

        if (IsJavaArgs()) {

            if (arg[0] != '-') {

                newArgv[newArgvIdx++] = arg;

                continue;

            }

        } else {

            if (JLI_StrCmp(arg, "-classpath") == 0 ||

                JLI_StrCmp(arg, "-cp") == 0) {

                newArgv[newArgvIdx++] = arg;

                argi++;

                if (argi < argc) {

                    newArgv[newArgvIdx++] = (*argv)[argi];

                }

                continue;

            }

            if (arg[0] != '-') break;

        }

        /* Did the user pass an explicit VM type? */

        i = KnownVMIndex(arg);

        if (i >= 0) {

            jvmtype = knownVMs[jvmidx = i].name + 1; /* skip the - */

            isVMType = 1;

            *pargc = *pargc - 1;

        }

        /* Did the user specify an "alternate" VM? */

        else if (JLI_StrCCmp(arg, "-XXaltjvm=") == 0 || JLI_StrCCmp(arg, "-J-XXaltjvm=") == 0) {

            isVMType = 1;

            jvmtype = arg+((arg[1]=='X')? 10 : 12);

            jvmidx = -1;

        }

        if (!isVMType) {

            newArgv[newArgvIdx++] = arg;

        }

    }

    /*