/*

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

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

#include <Cocoa/Cocoa.h>

#include <objc/objc-runtime.h>

#include <objc/objc-auto.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)

 *  |

 * \|/

 * 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

 * (processes version options,

 *  creates argument list for vm,

 *  etc.)

 *   |

 *   |

 *  \|/

 * POINT A

 *   |

 *   |

 *  \|/

 * Path is desired JRE ? YES --> Continue

 *  NO

 *   |

 *   |

 *  \|/

 * Paths have well known

 * jvm paths ?       --> NO --> Continue

 *  YES

 *   |

 *   |

 *  \|/

 *  Does libjvm.so exist

 *  in any of them ? --> NO --> Continue

 *   YES

 *   |

 *   |

 *  \|/

 * Re-exec / Spawn

 *   |

 *   |

 *  \|/

 * Main

 */

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

}

/*

 * 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), 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));

    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;

}

#ifndef STATIC_BUILD

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);

}

#endif

/*

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

{

    if (main_fptr == NULL) {

#ifdef STATIC_BUILD

        extern int main(int argc, char **argv);

        main_fptr = &main;

#else

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

#endif

        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) {

    jboolean jvmpathExists;

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

    SetExecname(*pargv);

    char * jvmtype    = NULL;

    int  argc         = *pargc;

    char **argv       = *pargv;

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

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

        JLI_ReportErrorMessage(JRE_ERROR1);

        exit(2);

    }

    JLI_Snprintf(jvmcfg, so_jvmcfg, "%s%slib%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)) {

        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

     */

    return;

}

/*

 * VM choosing is done by the launcher (java.c).

 */

static jboolean

GetJVMPath(const char *jrepath, const char *jvmtype,

           char *jvmpath, jint jvmpathsize)

{

    struct stat s;

    if (JLI_StrChr(jvmtype, '/')) {

        JLI_Snprintf(jvmpath, jvmpathsize, "%s/" JVM_DLL, jvmtype);

    } else {

        /*

         * macosx client library is built thin, i386 only.

         * 64 bit client requests must load server library

         */

        JLI_Snprintf(jvmpath, jvmpathsize, "%s/lib/%s/" JVM_DLL, jrepath, jvmtype);

    }

    JLI_TraceLauncher("Does `%s' exist ... ", jvmpath);

#ifdef STATIC_BUILD

    return JNI_TRUE;

#else

    if (stat(jvmpath, &s) == 0) {

        JLI_TraceLauncher("yes.\n");

        return JNI_TRUE;

    } else {

        JLI_TraceLauncher("no.\n");

        return JNI_FALSE;

    }

#endif

}

/*

 * Find path to JRE based on .exe's location or registry settings.

 */

static jboolean

GetJREPath(char *path, jint pathsize, jboolean speculative)

{

    char libjava[MAXPATHLEN];

    if (GetApplicationHome(path, pathsize)) {

        /* Is JRE co-located with the application? */

#ifdef STATIC_BUILD

        char jvm_cfg[MAXPATHLEN];

        JLI_Snprintf(jvm_cfg, sizeof(jvm_cfg), "%s/lib/jvm.cfg", path);

        if (access(jvm_cfg, F_OK) == 0) {

            return JNI_TRUE;

        }

#else

        JLI_Snprintf(libjava, sizeof(libjava), "%s/lib/" JAVA_DLL, path);

        if (access(libjava, F_OK) == 0) {

            return JNI_TRUE;

        }

#endif

        /* ensure storage for path + /jre + NULL */

        if ((JLI_StrLen(path) + 4 + 1) > (size_t) pathsize) {

            JLI_TraceLauncher("Insufficient space to store JRE path\n");

            return JNI_FALSE;

        }

        /* Does the app ship a private JRE in <apphome>/jre directory? */

        JLI_Snprintf(libjava, sizeof(libjava), "%s/jre/lib/" JAVA_DLL, path);

        if (access(libjava, F_OK) == 0) {

            JLI_StrCat(path, "/jre");

            JLI_TraceLauncher("JRE path is %s\n", path);

            return JNI_TRUE;

        }

    }

    /* try to find ourselves instead */

    Dl_info selfInfo;

    dladdr(&GetJREPath, &selfInfo);

#ifdef STATIC_BUILD

    char jvm_cfg[MAXPATHLEN];

    char *p = NULL;

    strncpy(jvm_cfg, selfInfo.dli_fname, MAXPATHLEN);

    p = strrchr(jvm_cfg, '/'); *p = '\0';

    p = strrchr(jvm_cfg, '/');

    if (strcmp(p, "/.") == 0) {

      *p = '\0';

      p = strrchr(jvm_cfg, '/'); *p = '\0';

    }

    else *p = '\0';

    strncpy(path, jvm_cfg, pathsize);

    strncat(jvm_cfg, "/lib/jvm.cfg", MAXPATHLEN);

    if (access(jvm_cfg, F_OK) == 0) {

      return JNI_TRUE;

    }

#endif

    char *realPathToSelf = realpath(selfInfo.dli_fname, path);

    if (realPathToSelf != path) {

        return JNI_FALSE;

    }

    size_t pathLen = strlen(realPathToSelf);

    if (pathLen == 0) {

        return JNI_FALSE;

    }

    const char lastPathComponent[] = "/lib/libjli.dylib";

    size_t sizeOfLastPathComponent = sizeof(lastPathComponent) - 1;

    if (pathLen < sizeOfLastPathComponent) {

        return JNI_FALSE;

    }

    size_t indexOfLastPathComponent = pathLen - sizeOfLastPathComponent;

    if (0 == strncmp(realPathToSelf + indexOfLastPathComponent, lastPathComponent, sizeOfLastPathComponent - 1)) {

        realPathToSelf[indexOfLastPathComponent + 1] = '\0';