/*

 * Copyright (c) 1995, 2015, 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.  Oracle designates this

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

 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.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.  The CreateExecutionEnvironment function processes

 * and removes -d<n> options. On unix, there is a possibility that the running

 * data model may not match to the desired data model, in this case an exec is

 * required to start the desired model. If the data models match, then

 * ParseArguments will remove the -d<n> flags. If the data models do not match

 * the CreateExecutionEnviroment will remove the -d<n> flags.

 */

#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.

 */

/* we always print to stderr */

#define USE_STDERR JNI_TRUE

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 jboolean dryRun = JNI_FALSE;       /* initialize VM and exit */

static char     *listModules = NULL;

static const char *_program_name;

static const char *_launcher_name;

static jboolean _is_java_args = JNI_FALSE;

static jboolean _have_classpath = JNI_FALSE;

static const char *_fVersion;

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 SetMainModule(const char *s);

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

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

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

                               int *pmode, char **pwhat,

                               int *pret, const char *jrepath);

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

                              InvocationFunctions *ifn);

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

static jclass LoadMainClass(JNIEnv *env, int mode, char *name);

static jclass GetApplicationClass(JNIEnv *env);

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 ShowSettings(JNIEnv* env, char *optString);

static void ListModules(JNIEnv* env, char *optString);

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(int minimum);

static int  KnownVMIndex(const char* name);

static void FreeKnownVMs();

static jboolean IsWildCardEnabled();

#define ARG_CHECK(AC_arg_count, AC_failure_message, AC_questionable_arg) \

    do { \

        if (AC_arg_count < 1) { \

            JLI_ReportErrorMessage(AC_failure_message, AC_questionable_arg); \

            printUsage = JNI_TRUE; \

            *pret = 1; \

            return JNI_TRUE; \

        } \

    } while (JNI_FALSE)

/*

 * 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 */

static jlong maxHeapSize        = 0;  /* max heap size */

static jlong initialHeapSize    = 0;  /* inital heap size */

/*

 * A minimum -Xss stack size suitable for all platforms.

 */

#ifndef STACK_SIZE_MINIMUM

#define STACK_SIZE_MINIMUM (32 * KB)

#endif

/*

 * 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,                 /* UNUSED 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 */

)

{

    int mode = LM_UNKNOWN;

    char *what = NULL;

    char *main_class = NULL;

    int ret;

    InvocationFunctions ifn;

    jlong start, end;

    char jvmpath[MAXPATHLEN];

    char jrepath[MAXPATHLEN];

    char jvmcfg[MAXPATHLEN];

    _fVersion = fullversion;

    _launcher_name = lname;

    _program_name = pname;

    _is_java_args = javaargs;

    _wc_enabled = cpwildcard;

    _ergo_policy = ergo;

    InitLauncher(javaw);

    DumpState();

    if (JLI_IsTraceLauncher()) {

        int i;

        printf("Command line args:\n");

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

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

        }

        AddOption("-Dsun.java.launcher.diag=true", NULL);

    }

    /*

     * SelectVersion() has several responsibilities:

     *

     *  1) Disallow specification of another JRE.  With 1.9, another

     *     version of the JRE cannot be invoked.

     *  2) Allow for a JRE version to invoke JDK 1.9 or later.  Since

     *     all mJRE directives have been stripped from the request but

     *     the pre 1.9 JRE [ 1.6 thru 1.8 ], it is as if 1.9+ has been

     *     invoked from the command line.

     */

    SelectVersion(argc, argv, &main_class);

    CreateExecutionEnvironment(&argc, &argv,

                               jrepath, sizeof(jrepath),

                               jvmpath, sizeof(jvmpath),

                               jvmcfg,  sizeof(jvmcfg));

    if (!IsJavaArgs()) {

        SetJvmEnvironment(argc,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 */

        char* cpath = getenv("CLASSPATH");

        if (cpath != NULL) {

            SetClassPath(cpath);

        }

    }

    /* Parse command line options; if the return value of

     * ParseArguments is false, the program should exit.

     */

    if (!ParseArguments(&argc, &argv, &mode, &what, &ret, jrepath))

    {

        return(ret);

    }

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

    if (mode == LM_JAR) {

        SetClassPath(what);     /* Override class path */

    }

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

    SetJavaCommandLineProp(what, argc, argv);

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

    SetJavaLauncherProp();

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

    SetJavaLauncherPlatformProps();

    return JVMInit(&ifn, threadStackSize, argc, argv, mode, what, ret);

}

/*

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

 *

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

 */

#define LEAVE() \

    do { \

        if ((*vm)->DetachCurrentThread(vm) != JNI_OK) { \

            JLI_ReportErrorMessage(JVM_ERROR2); \

            ret = 1; \

        } \

        if (JNI_TRUE) { \

            (*vm)->DestroyJavaVM(vm); \

            return ret; \

        } \

    } while (JNI_FALSE)

#define CHECK_EXCEPTION_NULL_LEAVE(CENL_exception) \

    do { \

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

            JLI_ReportExceptionDescription(env); \

            LEAVE(); \

        } \

        if ((CENL_exception) == NULL) { \

            JLI_ReportErrorMessage(JNI_ERROR); \

            LEAVE(); \

        } \

    } while (JNI_FALSE)

#define CHECK_EXCEPTION_LEAVE(CEL_return_value) \

    do { \

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

            JLI_ReportExceptionDescription(env); \

            ret = (CEL_return_value); \

            LEAVE(); \

        } \

    } while (JNI_FALSE)

int JNICALL

JavaMain(void * _args)

{

    JavaMainArgs *args = (JavaMainArgs *)_args;

    int argc = args->argc;

    char **argv = args->argv;

    int mode = args->mode;

    char *what = args->what;

    InvocationFunctions ifn = args->ifn;

    JavaVM *vm = 0;

    JNIEnv *env = 0;

    jclass mainClass = NULL;

    jclass appClass = NULL; // actual application class being launched

    jmethodID mainID;

    jobjectArray mainArgs;

    int ret = 0;

    jlong start, end;

    RegisterThread();

    /* Initialize the virtual machine */

    start = CounterGet();

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

        JLI_ReportErrorMessage(JVM_ERROR1);

        exit(1);

    }

    if (showSettings != NULL) {

        ShowSettings(env, showSettings);

        CHECK_EXCEPTION_LEAVE(1);

    }

    if (listModules != NULL) {

        ListModules(env, listModules);

        CHECK_EXCEPTION_LEAVE(1);

        LEAVE();

    }

    if (printVersion || showVersion) {

        PrintJavaVersion(env, showVersion);

        CHECK_EXCEPTION_LEAVE(0);

        if (printVersion) {

            LEAVE();

        }

    }

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

    if (printXUsage || printUsage || what == 0 || mode == LM_UNKNOWN) {

        PrintUsage(env, printXUsage);

        CHECK_EXCEPTION_LEAVE(1);

        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 application's arguments */

    if (JLI_IsTraceLauncher()){

        int i;

        printf("%s is '%s'\n", launchModeNames[mode], what);

        printf("App's 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. It also checks if the main

     * method exists.

     *

     * 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).

     *

     * This method also correctly handles launching existing JavaFX

     * applications that may or may not have a Main-Class manifest entry.

     */

    mainClass = LoadMainClass(env, mode, what);

    CHECK_EXCEPTION_NULL_LEAVE(mainClass);

    /*

     * In some cases when launching an application that needs a helper, e.g., a

     * JavaFX application with no main method, the mainClass will not be the

     * applications own main class but rather a helper class. To keep things

     * consistent in the UI we need to track and report the application main class.

     */

    appClass = GetApplicationClass(env);

    NULL_CHECK_RETURN_VALUE(appClass, -1);

    /* Build platform specific argument array */

    mainArgs = CreateApplicationArgs(env, argv, argc);

    CHECK_EXCEPTION_NULL_LEAVE(mainArgs);

    if (dryRun) {

        ret = 0;

        LEAVE();

    }

    /*

     * PostJVMInit uses the class name as the application name for GUI purposes,

     * for example, on OSX this sets the application name in the menu bar for

     * both SWT and JavaFX. So we'll pass the actual application class here

     * instead of mainClass as that may be a launcher or helper class instead

     * of the application class.

     */

    PostJVMInit(env, appClass, vm);