/*

 * Copyright (c) 2012, 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.

 */

#include "java.h"

#include "jvm_md.h"

#include <dirent.h>

#include <dlfcn.h>

#include <fcntl.h>

#include <inttypes.h>

#include <stdio.h>

#include <string.h>

#include <stdlib.h>

#include <sys/stat.h>

#include <unistd.h>

#include <sys/types.h>

#include <sys/time.h>

#include "manifest_info.h"

#include "version_comp.h"

/* Support Cocoa event loop on the main thread */

#include <Cocoa/Cocoa.h>

#include <objc/objc-runtime.h>

#include <objc/objc-auto.h>

#include <dispatch/dispatch.h>

#include <errno.h>

#include <spawn.h>

struct NSAppArgs {

    int argc;

    char **argv;

};

#define JVM_DLL "libjvm.dylib"

#define JAVA_DLL "libjava.dylib"

/* FALLBACK avoids naming conflicts with system libraries

 * (eg, ImageIO's libJPEG.dylib) */

#define LD_LIBRARY_PATH "DYLD_FALLBACK_LIBRARY_PATH"

/*

 * If a processor / os combination has the ability to run binaries of

 * two data models and cohabitation of jre/jdk bits with both data

 * models is supported, then DUAL_MODE is defined. MacOSX is a hybrid

 * system in that, the universal library can contain all types of libraries

 * 32/64 and client/server, thus the spawn is capable of linking with the

 * appropriate library as requested.

 *

 * Notes:

 * 1. VM. DUAL_MODE is disabled, and not supported, however, it is left here in

 *    for experimentation and perhaps enable it in the future.

 * 2. At the time of this writing, the universal library contains only

 *    a server 64-bit server JVM.

 * 3. "-client" command line option is supported merely as a command line flag,

 *    for, compatibility reasons, however, a server VM will be launched.

 */

/*

 * Flowchart of launcher execs and options processing on unix

 *

 * The selection of the proper vm shared library to open depends on

 * several classes of command line options, including vm "flavor"

 * options (-client, -server) and the data model options, -d32  and

 * -d64, as well as a version specification which may have come from

 * the command line or from the manifest of an executable jar file.

 * The vm selection options are not passed to the running

 * virtual machine; they must be screened out by the launcher.

 *

 * The version specification (if any) is processed first by the

 * platform independent routine SelectVersion.  This may result in

 * the exec of the specified launcher version.

 *

 * Now, in most cases,the launcher will dlopen the target libjvm.so. All

 * required libraries are loaded by the runtime linker, using the known paths

 * baked into the shared libraries at compile time. Therefore,

 * in most cases, the launcher will only exec, if the data models are

 * mismatched, and will not set any environment variables, regardless of the

 * data models.

 *

 *

 *

 *  Main

 *  (incoming argv)

 *  |

 * \|/

 * SelectVersion

 * (selects the JRE version, note: not data model)

 *  |

 * \|/

 * CreateExecutionEnvironment

 * (determines desired data model)

 *  |

 *  |

 * \|/

 *  Have Desired Model ? --> NO --> Is Dual-Mode ? --> NO --> Exit(with error)

 *  |                                          |

 *  |                                          |

 *  |                                         \|/

 *  |                                         YES

 *  |                                          |

 *  |                                          |

 *  |                                         \|/

 *  |                                CheckJvmType

 *  |                               (removes -client, -server etc.)

 *  |                                          |

 *  |                                          |

 * \|/                                        \|/

 * YES                             Find the desired executable/library

 *  |                                          |

 *  |                                          |

 * \|/                                        \|/

 * CheckJvmType                             POINT A

 * (removes -client, -server, etc.)

 *  |

 *  |

 * \|/

 * TranslateDashJArgs...

 * (Prepare to pass args to vm)

 *  |

 *  |

 * \|/

 * ParseArguments

 * (removes -d32 and -d64 if any,

 *  processes version options,

 *  creates argument list for vm,

 *  etc.)

 *   |

 *   |

 *  \|/

 * POINT A

 *   |

 *   |

 *  \|/

 * Path is desired JRE ? YES --> Have Desired Model ? NO --> Re-exec --> Main

 *  NO                               YES --> Continue

 *   |

 *   |

 *  \|/

 * Paths have well known

 * jvm paths ?       --> NO --> Have Desired Model ? NO --> Re-exec --> Main

 *  YES                              YES --> Continue

 *   |

 *   |

 *  \|/

 *  Does libjvm.so exist

 *  in any of them ? --> NO --> Have Desired Model ? NO --> Re-exec --> Main

 *   YES                             YES --> Continue

 *   |

 *   |

 *  \|/

 * Re-exec / Spawn

 *   |

 *   |

 *  \|/

 * Main

 */

#define GetArch() GetArchPath(CURRENT_DATA_MODEL)

/* Store the name of the executable once computed */

static char *execname = NULL;

/*

 * execname accessor from other parts of platform dependent logic

 */

const char *

GetExecName() {

    return execname;

}

const char *

GetArchPath(int nbits)

{

    switch(nbits) {

        default:

            return LIBARCHNAME;

    }

}

/*

 * Exports the JNI interface from libjli

 *

 * This allows client code to link against the .jre/.jdk bundles,

 * and not worry about trying to pick a HotSpot to link against.

 *

 * Switching architectures is unsupported, since client code has

 * made that choice before the JVM was requested.

 */

static InvocationFunctions *sExportedJNIFunctions = NULL;

static char *sPreferredJVMType = NULL;

static InvocationFunctions *GetExportedJNIFunctions() {

    if (sExportedJNIFunctions != NULL) return sExportedJNIFunctions;

    char jrePath[PATH_MAX];

    jboolean gotJREPath = GetJREPath(jrePath, sizeof(jrePath), GetArch(), JNI_FALSE);

    if (!gotJREPath) {

        JLI_ReportErrorMessage("Failed to GetJREPath()");

        return NULL;

    }

    char *preferredJVM = sPreferredJVMType;

    if (preferredJVM == NULL) {

#if defined(__i386__)

        preferredJVM = "client";

#elif defined(__x86_64__)

        preferredJVM = "server";

#else

#error "Unknown architecture - needs definition"

#endif

    }

    char jvmPath[PATH_MAX];

    jboolean gotJVMPath = GetJVMPath(jrePath, preferredJVM, jvmPath, sizeof(jvmPath), GetArch(), CURRENT_DATA_MODEL);

    if (!gotJVMPath) {

        JLI_ReportErrorMessage("Failed to GetJVMPath()");

        return NULL;

    }

    InvocationFunctions *fxns = malloc(sizeof(InvocationFunctions));

    jboolean vmLoaded = LoadJavaVM(jvmPath, fxns);

    if (!vmLoaded) {

        JLI_ReportErrorMessage("Failed to LoadJavaVM()");

        return NULL;

    }

    return sExportedJNIFunctions = fxns;

}

JNIEXPORT jint JNICALL

JNI_GetDefaultJavaVMInitArgs(void *args) {

    InvocationFunctions *ifn = GetExportedJNIFunctions();

    if (ifn == NULL) return JNI_ERR;

    return ifn->GetDefaultJavaVMInitArgs(args);

}

JNIEXPORT jint JNICALL

JNI_CreateJavaVM(JavaVM **pvm, void **penv, void *args) {

    InvocationFunctions *ifn = GetExportedJNIFunctions();

    if (ifn == NULL) return JNI_ERR;

    return ifn->CreateJavaVM(pvm, penv, args);

}

JNIEXPORT jint JNICALL

JNI_GetCreatedJavaVMs(JavaVM **vmBuf, jsize bufLen, jsize *nVMs) {

    InvocationFunctions *ifn = GetExportedJNIFunctions();

    if (ifn == NULL) return JNI_ERR;

    return ifn->GetCreatedJavaVMs(vmBuf, bufLen, nVMs);

}

/*

 * Allow JLI-aware launchers to specify a client/server preference

 */

JNIEXPORT void JNICALL

JLI_SetPreferredJVM(const char *prefJVM) {

    if (sPreferredJVMType != NULL) {

        free(sPreferredJVMType);

        sPreferredJVMType = NULL;

    }

    if (prefJVM == NULL) return;

    sPreferredJVMType = strdup(prefJVM);

}

static BOOL awtLoaded = NO;

static pthread_mutex_t awtLoaded_mutex = PTHREAD_MUTEX_INITIALIZER;

static pthread_cond_t  awtLoaded_cv = PTHREAD_COND_INITIALIZER;

JNIEXPORT void JNICALL

JLI_NotifyAWTLoaded()

{

    pthread_mutex_lock(&awtLoaded_mutex);

    awtLoaded = YES;

    pthread_cond_signal(&awtLoaded_cv);

    pthread_mutex_unlock(&awtLoaded_mutex);

}

static int (*main_fptr)(int argc, char **argv) = NULL;

/*

 * Unwrap the arguments and re-run main()

 */

static void *apple_main (void *arg)

{

    objc_registerThreadWithCollector();

    if (main_fptr == NULL) {

        main_fptr = (int (*)())dlsym(RTLD_DEFAULT, "main");

        if (main_fptr == NULL) {

            JLI_ReportErrorMessageSys("error locating main entrypoint\n");

            exit(1);

        }

    }

    struct NSAppArgs *args = (struct NSAppArgs *) arg;

    exit(main_fptr(args->argc, args->argv));

}

static void dummyTimer(CFRunLoopTimerRef timer, void *info) {}

static void ParkEventLoop() {

    // RunLoop needs at least one source, and 1e20 is pretty far into the future

    CFRunLoopTimerRef t = CFRunLoopTimerCreate(kCFAllocatorDefault, 1.0e20, 0.0, 0, 0, dummyTimer, NULL);

    CFRunLoopAddTimer(CFRunLoopGetCurrent(), t, kCFRunLoopDefaultMode);

    CFRelease(t);

    // Park this thread in the main run loop.

    int32_t result;

    do {

        result = CFRunLoopRunInMode(kCFRunLoopDefaultMode, 1.0e20, false);

    } while (result != kCFRunLoopRunFinished);

}

/*

 * Mac OS X mandates that the GUI event loop run on very first thread of

 * an application. This requires that we re-call Java's main() on a new

 * thread, reserving the 'main' thread for Cocoa.

 */

static void MacOSXStartup(int argc, char *argv[]) {

    // Thread already started?

    static jboolean started = false;

    if (started) {

        return;

    }

    started = true;

    // Hand off arguments

    struct NSAppArgs args;

    args.argc = argc;

    args.argv = argv;

    // Fire up the main thread

    pthread_t main_thr;

    if (pthread_create(&main_thr, NULL, &apple_main, &args) != 0) {

        JLI_ReportErrorMessageSys("Could not create main thread: %s\n", strerror(errno));

        exit(1);

    }

    if (pthread_detach(main_thr)) {

        JLI_ReportErrorMessageSys("pthread_detach() failed: %s\n", strerror(errno));

        exit(1);

    }

    ParkEventLoop();

}

void

CreateExecutionEnvironment(int *pargc, char ***pargv,

                           char jrepath[], jint so_jrepath,

                           char jvmpath[], jint so_jvmpath,

                           char jvmcfg[],  jint so_jvmcfg) {

  /*

   * First, determine if we are running the desired data model.  If we

   * are running the desired data model, all the error messages

   * associated with calling GetJREPath, ReadKnownVMs, etc. should be

   * output.  However, if we are not running the desired data model,

   * some of the errors should be suppressed since it is more

   * informative to issue an error message based on whether or not the

   * os/processor combination has dual mode capabilities.

   */

    jboolean jvmpathExists;

    /* Compute/set the name of the executable */

    SetExecname(*pargv);

    /* Check data model flags, and exec process, if needed */

    {

      char *arch        = (char *)GetArch(); /* like sparc or sparcv9 */

      char * jvmtype    = NULL;

      int  argc         = *pargc;

      char **argv       = *pargv;

      int running       = CURRENT_DATA_MODEL;

      int wanted        = running;      /* What data mode is being

                                           asked for? Current model is

                                           fine unless another model

                                           is asked for */

      char** newargv    = NULL;

      int    newargc    = 0;

      /*

       * Starting in 1.5, all unix platforms accept the -d32 and -d64

       * options.  On platforms where only one data-model is supported

       * (e.g. ia-64 Linux), using the flag for the other data model is

       * an error and will terminate the program.

       */

      { /* open new scope to declare local variables */

        int i;

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

        newargv[newargc++] = argv[0];

        /* scan for data model arguments and remove from argument list;

           last occurrence determines desired data model */

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

          if (JLI_StrCmp(argv[i], "-J-d64") == 0 || JLI_StrCmp(argv[i], "-d64") == 0) {

            wanted = 64;

            continue;

          }

          if (JLI_StrCmp(argv[i], "-J-d32") == 0 || JLI_StrCmp(argv[i], "-d32") == 0) {

            wanted = 32;

            continue;

          }

          newargv[newargc++] = argv[i];

          if (IsJavaArgs()) {

            if (argv[i][0] != '-') continue;

          } else {

            if (JLI_StrCmp(argv[i], "-classpath") == 0 || JLI_StrCmp(argv[i], "-cp") == 0) {

              i++;

              if (i >= argc) break;

              newargv[newargc++] = argv[i];

              continue;

            }

            if (argv[i][0] != '-') { i++; break; }

          }

        }

        /* copy rest of args [i .. argc) */

        while (i < argc) {

          newargv[newargc++] = argv[i++];

        }

        newargv[newargc] = NULL;

        /*

         * newargv has all proper arguments here

         */

        argc = newargc;

        argv = newargv;

      }

      /* If the data model is not changing, it is an error if the

         jvmpath does not exist */

      if (wanted == running) {

        /* Find out where the JRE is that we will be using. */

        if (!GetJREPath(jrepath, so_jrepath, arch, JNI_FALSE) ) {

          JLI_ReportErrorMessage(JRE_ERROR1);

          exit(2);

        }

        JLI_Snprintf(jvmcfg, so_jvmcfg, "%s%slib%s%s%sjvm.cfg",

          jrepath, FILESEP, FILESEP,  "", "");

        /* Find the specified JVM type */

        if (ReadKnownVMs(jvmcfg, JNI_FALSE) < 1) {

          JLI_ReportErrorMessage(CFG_ERROR7);

          exit(1);

        }

        jvmpath[0] = '\0';

        jvmtype = CheckJvmType(pargc, pargv, JNI_FALSE);

        if (JLI_StrCmp(jvmtype, "ERROR") == 0) {

            JLI_ReportErrorMessage(CFG_ERROR9);

            exit(4);

        }

        if (!GetJVMPath(jrepath, jvmtype, jvmpath, so_jvmpath, arch, wanted)) {

          JLI_ReportErrorMessage(CFG_ERROR8, jvmtype, jvmpath);

          exit(4);

        }

        /*

         * Mac OS X requires the Cocoa event loop to be run on the "main"

         * thread. Spawn off a new thread to run main() and pass

         * this thread off to the Cocoa event loop.

         */

        MacOSXStartup(argc, argv);

        /*

         * we seem to have everything we need, so without further ado

         * we return back, otherwise proceed to set the environment.

         */

        return;

      } else {  /* do the same speculatively or exit */

#if defined(DUAL_MODE)

        if (running != wanted) {

          /* Find out where the JRE is that we will be using. */

          if (!GetJREPath(jrepath, so_jrepath, GetArchPath(wanted), JNI_TRUE)) {

            /* give up and let other code report error message */

            JLI_ReportErrorMessage(JRE_ERROR2, wanted);

            exit(1);

          }

          JLI_Snprintf(jvmcfg, so_jvmcfg, "%s%slib%s%s%sjvm.cfg",

            jrepath, FILESEP, FILESEP,  "", "");

          /*

           * Read in jvm.cfg for target data model and process vm

           * selection options.

           */

          if (ReadKnownVMs(jvmcfg, JNI_TRUE) < 1) {

            /* give up and let other code report error message */

            JLI_ReportErrorMessage(JRE_ERROR2, wanted);

            exit(1);

          }

          jvmpath[0] = '\0';

          jvmtype = CheckJvmType(pargc, pargv, JNI_TRUE);

          if (JLI_StrCmp(jvmtype, "ERROR") == 0) {

            JLI_ReportErrorMessage(CFG_ERROR9);

            exit(4);

          }

          /* exec child can do error checking on the existence of the path */

          jvmpathExists = GetJVMPath(jrepath, jvmtype, jvmpath, so_jvmpath, GetArchPath(wanted), wanted);

        }

#else /* ! DUAL_MODE */