/*

 * Copyright (c) 1998, 2010, 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 <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 "manifest_info.h"

#include "version_comp.h"

#ifdef __linux__

#include <pthread.h>

#else

#include <thread.h>

#endif

#define JVM_DLL "libjvm.so"

#define JAVA_DLL "libjava.so"

/*

 * 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.  When DUAL_MODE is

 * defined, the architecture names for the narrow and wide version of

 * the architecture are defined in LIBARCH64NAME and LIBARCH32NAME.

 * Currently  only Solaris on sparc/sparcv9 and i586/amd64 is DUAL_MODE;

 * linux i586/amd64 could be defined as DUAL_MODE but that is not the

 * current policy.

 */

#ifdef __solaris__

#  define DUAL_MODE

#  ifndef LIBARCH32NAME

#    error "The macro LIBARCH32NAME was not defined on the compile line"

#  endif

#  ifndef LIBARCH64NAME

#    error "The macro LIBARCH64NAME was not defined on the compile line"

#  endif

#  include <sys/systeminfo.h>

#  include <sys/elf.h>

#  include <stdio.h>

#endif

/* pointer to environment */

extern char **environ;

/*

 *      A collection of useful strings. One should think of these as #define

 *      entries, but actual strings can be more efficient (with many compilers).

 */

#ifdef __linux__

static const char *system_dir   = "/usr/java";

static const char *user_dir     = "/java";

#else /* Solaris */

static const char *system_dir   = "/usr/jdk";

static const char *user_dir     = "/jdk";

#endif

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

static char *execname = NULL;

/*

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

 *

 * Previously the launcher modified the LD_LIBRARY_PATH appropriately for the

 * desired data model path, regardless if data models matched or not. The

 * launcher subsequently exec'ed the desired executable, in order to make the

 * LD_LIBRARY_PATH path available for the runtime linker. This is no longer the

 * case, the launcher dlopens the target libjvm.so. All other required

 * libraries are loaded by the runtime linker, by virtue of the $ORIGIN paths

 * baked into the shared libraries, by the build infrastructure at compile time.

 *

 *  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 and exec child)

 *  |                                          |

 *  |                                          |

 * \|/                                        \|/

 * CheckJvmType                                Main

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

 *

 */

static const char * SetExecname(char **argv);

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

                           char *jvmpath, jint jvmpathsize, const char * arch);

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

#define GetArch() GetArchPath(CURRENT_DATA_MODEL)

const char *

GetArchPath(int nbits)

{

    switch(nbits) {

#ifdef DUAL_MODE

        case 32:

            return LIBARCH32NAME;

        case 64:

            return LIBARCH64NAME;

#endif /* DUAL_MODE */

        default:

            return LIBARCHNAME;

    }

}

void

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

                           char jrepath[], jint so_jrepath,

                           char jvmpath[], jint so_jvmpath) {

  /*

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

        }

        /* Find the specified JVM type */

        if (ReadKnownVMs(jrepath, arch, 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 )) {

          JLI_ReportErrorMessage(CFG_ERROR8, jvmtype, jvmpath);

          exit(4);

        }

        /*

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

         * we return back.

         */

        return;

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

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

          }

          /*

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

           * selection options.

           */

          if (ReadKnownVMs(jrepath, GetArchPath(wanted), 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));

        }

#else

        JLI_ReportErrorMessage(JRE_ERROR2, wanted);

        exit(1);

#endif

      }

      {

        char *newexec = execname;

#ifdef DUAL_MODE

        /*

         * If the data model is being changed, the path to the

         * executable must be updated accordingly; the executable name

         * and directory the executable resides in are separate.  In the

         * case of 32 => 64, the new bits are assumed to reside in, e.g.

         * "olddir/LIBARCH64NAME/execname"; in the case of 64 => 32,

         * the bits are assumed to be in "olddir/../execname".  For example,

         *

         * olddir/sparcv9/execname

         * olddir/amd64/execname

         *

         * for Solaris SPARC and Linux amd64, respectively.

         */

        if (running != wanted) {

          char *oldexec = JLI_StrCpy(JLI_MemAlloc(JLI_StrLen(execname) + 1), execname);

          char *olddir = oldexec;

          char *oldbase = JLI_StrRChr(oldexec, '/');

          newexec = JLI_MemAlloc(JLI_StrLen(execname) + 20);

          *oldbase++ = 0;

          sprintf(newexec, "%s/%s/%s", olddir,

                  ((wanted==64) ? LIBARCH64NAME : ".."), oldbase);

          argv[0] = newexec;

        }

#endif

        JLI_TraceLauncher("TRACER_MARKER:About to EXEC\n");

        (void)fflush(stdout);

        (void)fflush(stderr);

        execv(newexec, argv);

        JLI_ReportErrorMessageSys(JRE_ERROR4, newexec);

#ifdef DUAL_MODE

        if (running != wanted) {

          JLI_ReportErrorMessage(JRE_ERROR5, wanted, running);

#  ifdef __solaris__

#    ifdef __sparc

          JLI_ReportErrorMessage(JRE_ERROR6);

#    else

          JLI_ReportErrorMessage(JRE_ERROR7);

#    endif

        }

#  endif

#endif

      }

      exit(1);

    }

}

/*

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

 */

static jboolean

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

           char *jvmpath, jint jvmpathsize, const char * arch)

{

    struct stat s;

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

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

    } else {

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

    }

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

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

        JLI_TraceLauncher("yes.\n");

        return JNI_TRUE;

    } else {

        JLI_TraceLauncher("no.\n");

        return JNI_FALSE;

    }

}

/*

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

 */

static jboolean

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

{

    char libjava[MAXPATHLEN];

    if (GetApplicationHome(path, pathsize)) {

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

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

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

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

            return JNI_TRUE;

        }

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

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

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

            JLI_StrCat(path, "/jre");

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

            return JNI_TRUE;

        }

    }

    if (!speculative)

      JLI_ReportErrorMessage(JRE_ERROR8 JAVA_DLL);

    return JNI_FALSE;

}

jboolean

LoadJavaVM(const char *jvmpath, InvocationFunctions *ifn)

{

    Dl_info dlinfo;

    void *libjvm;

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

    libjvm = dlopen(jvmpath, RTLD_NOW + RTLD_GLOBAL);

    if (libjvm == NULL) {

#if defined(__solaris__) && defined(__sparc) && !defined(_LP64) /* i.e. 32-bit sparc */

      FILE * fp;

      Elf32_Ehdr elf_head;

      int count;

      int location;

      fp = fopen(jvmpath, "r");

      if (fp == NULL) {

        JLI_ReportErrorMessage(DLL_ERROR2, jvmpath, dlerror());

        return JNI_FALSE;

      }

      /* read in elf header */

      count = fread((void*)(&elf_head), sizeof(Elf32_Ehdr), 1, fp);

      fclose(fp);

      if (count < 1) {

        JLI_ReportErrorMessage(DLL_ERROR2, jvmpath, dlerror());

        return JNI_FALSE;

      }

      /*

       * Check for running a server vm (compiled with -xarch=v8plus)

       * on a stock v8 processor.  In this case, the machine type in

       * the elf header would not be included the architecture list

       * provided by the isalist command, which is turn is gotten from

       * sysinfo.  This case cannot occur on 64-bit hardware and thus

       * does not have to be checked for in binaries with an LP64 data

       * model.

       */

      if (elf_head.e_machine == EM_SPARC32PLUS) {

        char buf[257];  /* recommended buffer size from sysinfo man

                           page */

        long length;

        char* location;

        length = sysinfo(SI_ISALIST, buf, 257);

        if (length > 0) {

            location = JLI_StrStr(buf, "sparcv8plus ");

          if (location == NULL) {

            JLI_ReportErrorMessage(JVM_ERROR3);

            return JNI_FALSE;

          }

        }

      }

#endif

        JLI_ReportErrorMessage(DLL_ERROR1, __LINE__);

        JLI_ReportErrorMessage(DLL_ERROR2, jvmpath, dlerror());

        return JNI_FALSE;

    }

    ifn->CreateJavaVM = (CreateJavaVM_t)

        dlsym(libjvm, "JNI_CreateJavaVM");

    if (ifn->CreateJavaVM == NULL) {