/*

 * Copyright (c) 1997, 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 <windows.h>

#include <io.h>

#include <process.h>

#include <stdlib.h>

#include <stdio.h>

#include <stdarg.h>

#include <string.h>

#include <sys/types.h>

#include <sys/stat.h>

#include <wtypes.h>

#include <commctrl.h>

#include <jni.h>

#include "java.h"

#define JVM_DLL "jvm.dll"

#define JAVA_DLL "java.dll"

/*

 * Prototypes.

 */

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

                           char *jvmpath, jint jvmpathsize);

static jboolean GetJREPath(char *path, jint pathsize);

#ifdef USE_REGISTRY_LOOKUP

jboolean GetPublicJREHome(char *buf, jint bufsize);

#endif

/* We supports warmup for UI stack that is performed in parallel

 * to VM initialization.

 * This helps to improve startup of UI application as warmup phase

 * might be long due to initialization of OS or hardware resources.

 * It is not CPU bound and therefore it does not interfere with VM init.

 * Obviously such warmup only has sense for UI apps and therefore it needs

 * to be explicitly requested by passing -Dsun.awt.warmup=true property

 * (this is always the case for plugin/javaws).

 *

 * Implementation launches new thread after VM starts and use it to perform

 * warmup code (platform dependent).

 * This thread is later reused as AWT toolkit thread as graphics toolkit

 * often assume that they are used from the same thread they were launched on.

 *

 * At the moment we only support warmup for D3D. It only possible on windows

 * and only if other flags do not prohibit this (e.g. OpenGL support requested).

 */

#undef ENABLE_AWT_PRELOAD

#ifndef JAVA_ARGS /* turn off AWT preloading for javac, jar, etc */

    /* CR6999872: fastdebug crashes if awt library is loaded before JVM is

     * initialized*/

    #if !defined(DEBUG)

        #define ENABLE_AWT_PRELOAD

    #endif

#endif

#ifdef ENABLE_AWT_PRELOAD

/* "AWT was preloaded" flag;

 * turned on by AWTPreload().

 */

int awtPreloaded = 0;

/* Calls a function with the name specified

 * the function must be int(*fn)(void).

 */

int AWTPreload(const char *funcName);

/* stops AWT preloading */

void AWTPreloadStop();

/* D3D preloading */

/* -1: not initialized; 0: OFF, 1: ON */

int awtPreloadD3D = -1;

/* command line parameter to swith D3D preloading on */

#define PARAM_PRELOAD_D3D "-Dsun.awt.warmup"

/* D3D/OpenGL management parameters */

#define PARAM_NODDRAW "-Dsun.java2d.noddraw"

#define PARAM_D3D "-Dsun.java2d.d3d"

#define PARAM_OPENGL "-Dsun.java2d.opengl"

/* funtion in awt.dll (src/windows/native/sun/java2d/d3d/D3DPipelineManager.cpp) */

#define D3D_PRELOAD_FUNC "preloadD3D"

/* Extracts value of a parameter with the specified name

 * from command line argument (returns pointer in the argument).

 * Returns NULL if the argument does not contains the parameter.

 * e.g.:

 * GetParamValue("theParam", "theParam=value") returns pointer to "value".

 */

const char * GetParamValue(const char *paramName, const char *arg) {

    size_t nameLen = JLI_StrLen(paramName);

    if (JLI_StrNCmp(paramName, arg, nameLen) == 0) {

        /* arg[nameLen] is valid (may contain final NULL) */

        if (arg[nameLen] == '=') {

            return arg + nameLen + 1;

        }

    }

    return NULL;

}

/* Checks if commandline argument contains property specified

 * and analyze it as boolean property (true/false).

 * Returns -1 if the argument does not contain the parameter;

 * Returns 1 if the argument contains the parameter and its value is "true";

 * Returns 0 if the argument contains the parameter and its value is "false".

 */

int GetBoolParamValue(const char *paramName, const char *arg) {

    const char * paramValue = GetParamValue(paramName, arg);

    if (paramValue != NULL) {

        if (JLI_StrCaseCmp(paramValue, "true") == 0) {

            return 1;

        }

        if (JLI_StrCaseCmp(paramValue, "false") == 0) {

            return 0;

        }

    }

    return -1;

}

#endif /* ENABLE_AWT_PRELOAD */

static jboolean _isjavaw = JNI_FALSE;

jboolean

IsJavaw()

{

    return _isjavaw;

}

/*

 *

 */

void

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

                           char *jrepath, jint so_jrepath,

                           char *jvmpath, jint so_jvmpath,

                           char *jvmcfg,  jint so_jvmcfg) {

    char *jvmtype;

    int i = 0;

    char** argv = *pargv;

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

    if (!GetJREPath(jrepath, so_jrepath)) {

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

    }

    jvmtype = CheckJvmType(pargc, pargv, JNI_FALSE);

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

        JLI_ReportErrorMessage(CFG_ERROR9);

        exit(4);

    }

    jvmpath[0] = '\0';

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

        JLI_ReportErrorMessage(CFG_ERROR8, jvmtype, jvmpath);

        exit(4);

    }

    /* If we got here, jvmpath has been correctly initialized. */

    /* Check if we need preload AWT */

#ifdef ENABLE_AWT_PRELOAD

    argv = *pargv;

    for (i = 0; i < *pargc ; i++) {

        /* Tests the "turn on" parameter only if not set yet. */

        if (awtPreloadD3D < 0) {

            if (GetBoolParamValue(PARAM_PRELOAD_D3D, argv[i]) == 1) {

                awtPreloadD3D = 1;

            }

        }

        /* Test parameters which can disable preloading if not already disabled. */

        if (awtPreloadD3D != 0) {

            if (GetBoolParamValue(PARAM_NODDRAW, argv[i]) == 1

                || GetBoolParamValue(PARAM_D3D, argv[i]) == 0

                || GetBoolParamValue(PARAM_OPENGL, argv[i]) == 1)

            {

                awtPreloadD3D = 0;

                /* no need to test the rest of the parameters */

                break;

            }

        }

    }

#endif /* ENABLE_AWT_PRELOAD */

}

static jboolean

LoadMSVCRT()

{

    // Only do this once

    static int loaded = 0;

    char crtpath[MAXPATHLEN];

    if (!loaded) {

        /*

         * The Microsoft C Runtime Library needs to be loaded first.  A copy is

         * assumed to be present in the "JRE path" directory.  If it is not found

         * there (or "JRE path" fails to resolve), skip the explicit load and let

         * nature take its course, which is likely to be a failure to execute.

         * The makefiles will provide the correct lib contained in quotes in the

         * macro MSVCR_DLL_NAME.

         */

#ifdef MSVCR_DLL_NAME

        if (GetJREPath(crtpath, MAXPATHLEN)) {

            if (JLI_StrLen(crtpath) + JLI_StrLen("\\bin\\") +

                    JLI_StrLen(MSVCR_DLL_NAME) >= MAXPATHLEN) {

                JLI_ReportErrorMessage(JRE_ERROR11);

                return JNI_FALSE;

            }

            (void)JLI_StrCat(crtpath, "\\bin\\" MSVCR_DLL_NAME);   /* Add crt dll */

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

            if (_access(crtpath, 0) == 0) {

                if (LoadLibrary(crtpath) == 0) {

                    JLI_ReportErrorMessage(DLL_ERROR4, crtpath);

                    return JNI_FALSE;

                }

            }

        }

#endif /* MSVCR_DLL_NAME */

#ifdef MSVCP_DLL_NAME

        if (GetJREPath(crtpath, MAXPATHLEN)) {

            if (JLI_StrLen(crtpath) + JLI_StrLen("\\bin\\") +

                    JLI_StrLen(MSVCP_DLL_NAME) >= MAXPATHLEN) {

                JLI_ReportErrorMessage(JRE_ERROR11);

                return JNI_FALSE;

            }

            (void)JLI_StrCat(crtpath, "\\bin\\" MSVCP_DLL_NAME);   /* Add prt dll */

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

            if (_access(crtpath, 0) == 0) {

                if (LoadLibrary(crtpath) == 0) {

                    JLI_ReportErrorMessage(DLL_ERROR4, crtpath);

                    return JNI_FALSE;

                }

            }

        }

#endif /* MSVCP_DLL_NAME */

        loaded = 1;

    }

    return JNI_TRUE;

}

/*

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

 */

jboolean

GetJREPath(char *path, jint pathsize)

{

    char javadll[MAXPATHLEN];

    struct stat s;

    if (GetApplicationHome(path, pathsize)) {

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

        JLI_Snprintf(javadll, sizeof(javadll), "%s\\bin\\" JAVA_DLL, path);

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

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

            return JNI_TRUE;

        }

        /* 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 this app ship a private JRE in <apphome>\jre directory? */

        JLI_Snprintf(javadll, sizeof (javadll), "%s\\jre\\bin\\" JAVA_DLL, path);

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

            JLI_StrCat(path, "\\jre");

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

            return JNI_TRUE;

        }

    }

    /* Try getting path to JRE from path to JLI.DLL */

    if (GetApplicationHomeFromDll(path, pathsize)) {

        JLI_Snprintf(javadll, sizeof(javadll), "%s\\bin\\" JAVA_DLL, path);

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

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

            return JNI_TRUE;

        }

    }

#ifdef USE_REGISTRY_LOOKUP

    /* Lookup public JRE using Windows registry. */

    if (GetPublicJREHome(path, pathsize)) {

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

        return JNI_TRUE;

    }

#endif

    JLI_ReportErrorMessage(JRE_ERROR8 JAVA_DLL);

    return JNI_FALSE;

}

/*

 * Given a JRE location and a JVM type, construct what the name the

 * JVM shared library will be.  Return true, if such a library

 * exists, false otherwise.

 */

static jboolean

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

           char *jvmpath, jint jvmpathsize)

{

    struct stat s;

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

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

    } else {

        JLI_Snprintf(jvmpath, jvmpathsize, "%s\\bin\\%s\\" JVM_DLL,

                     jrepath, jvmtype);

    }

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

        return JNI_TRUE;

    } else {

        return JNI_FALSE;

    }

}

/*

 * Load a jvm from "jvmpath" and initialize the invocation functions.

 */

jboolean

LoadJavaVM(const char *jvmpath, InvocationFunctions *ifn)

{

    HINSTANCE handle;

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

    /*

     * The Microsoft C Runtime Library needs to be loaded first.  A copy is

     * assumed to be present in the "JRE path" directory.  If it is not found

     * there (or "JRE path" fails to resolve), skip the explicit load and let

     * nature take its course, which is likely to be a failure to execute.

     *

     */

    LoadMSVCRT();

    /* Load the Java VM DLL */

    if ((handle = LoadLibrary(jvmpath)) == 0) {

        JLI_ReportErrorMessage(DLL_ERROR4, (char *)jvmpath);

        return JNI_FALSE;

    }

    /* Now get the function addresses */

    ifn->CreateJavaVM =

        (void *)GetProcAddress(handle, "JNI_CreateJavaVM");

    ifn->GetDefaultJavaVMInitArgs =

        (void *)GetProcAddress(handle, "JNI_GetDefaultJavaVMInitArgs");

    if (ifn->CreateJavaVM == 0 || ifn->GetDefaultJavaVMInitArgs == 0) {

        JLI_ReportErrorMessage(JNI_ERROR1, (char *)jvmpath);

        return JNI_FALSE;

    }

    return JNI_TRUE;

}

/*

 * Removes the trailing file name and one sub-folder from a path.

 * If buf is "c:\foo\bin\javac", then put "c:\foo" into buf.

 */

jboolean

TruncatePath(char *buf)

{

    char *cp;

    *JLI_StrRChr(buf, '\\') = '\0'; /* remove .exe file name */

    if ((cp = JLI_StrRChr(buf, '\\')) == 0) {

        /* This happens if the application is in a drive root, and

         * there is no bin directory. */

        buf[0] = '\0';

        return JNI_FALSE;

    }

    *cp = '\0'; /* remove the bin\ part */

    return JNI_TRUE;

}

/*

 * Retrieves the path to the JRE home by locating the executable file

 * of the current process and then truncating the path to the executable

 */

jboolean

GetApplicationHome(char *buf, jint bufsize)

{

    GetModuleFileName(NULL, buf, bufsize);

    return TruncatePath(buf);

}

/*

 * Retrieves the path to the JRE home by locating JLI.DLL and

 * then truncating the path to JLI.DLL

 */

jboolean

GetApplicationHomeFromDll(char *buf, jint bufsize)

{

    HMODULE module;

    DWORD flags = GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS |

                  GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT;

    if (GetModuleHandleEx(flags, (LPCSTR)&GetJREPath, &module) != 0) {

        if (GetModuleFileName(module, buf, bufsize) != 0) {

            return TruncatePath(buf);

        }

    }

    return JNI_FALSE;

}

/*

 * Support for doing cheap, accurate interval timing.

 */

static jboolean counterAvailable = JNI_FALSE;

static jboolean counterInitialized = JNI_FALSE;

static LARGE_INTEGER counterFrequency;

jlong CounterGet()

{

    LARGE_INTEGER count;

    if (!counterInitialized) {

        counterAvailable = QueryPerformanceFrequency(&counterFrequency);

        counterInitialized = JNI_TRUE;

    }

    if (!counterAvailable) {

        return 0;

    }

    QueryPerformanceCounter(&count);

    return (jlong)(count.QuadPart);

}

jlong Counter2Micros(jlong counts)

{

    if (!counterAvailable || !counterInitialized) {

        return 0;

    }

    return (counts * 1000 * 1000)/counterFrequency.QuadPart;

}

/*

 * windows snprintf does not guarantee a null terminator in the buffer,

 * if the computed size is equal to or greater than the buffer size,

 * as well as error conditions. This function guarantees a null terminator

 * under all these conditions. An unreasonable buffer or size will return

 * an error value. Under all other conditions this function will return the

 * size of the bytes actually written minus the null terminator, similar

 * to ansi snprintf api. Thus when calling this function the caller must

 * ensure storage for the null terminator.

 */

int

JLI_Snprintf(char* buffer, size_t size, const char* format, ...) {

    int rc;

    va_list vl;

    if (size == 0 || buffer == NULL)

        return -1;

    buffer[0] = '\0';

    va_start(vl, format);

    rc = vsnprintf(buffer, size, format, vl);

    va_end(vl);

    /* force a null terminator, if something is amiss */

    if (rc < 0) {

        /* apply ansi semantics */

        buffer[size - 1] = '\0';

        return (int)size;

    } else if (rc == size) {

        /* force a null terminator */

        buffer[size - 1] = '\0';

    }

    return rc;

}

/* taken from hotspot and slightly adjusted for jli lib;

 * creates a UNC/ELP path from input 'path'

 * the return buffer is allocated in C heap and needs to be freed using

 * JLI_MemFree by the caller.