/*

 * Copyright 1998-2008 Sun Microsystems, Inc.  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.  Sun designates this

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

 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.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.

 *

 * Typically, the launcher execs at least once to ensure a suitable

 * LD_LIBRARY_PATH is in effect for the process.  The first exec

 * screens out all the data model options; leaving the choice of data

 * model implicit in the binary selected to run.  However, in case no

 * exec is done, the data model options are screened out before the vm

 * is invoked.

 *

 *  incoming argv ------------------------------

 *  |                                          |

 * \|/                                         |

 * CheckJVMType                                |

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

 *                                            \|/

 *                                            CreateExecutionEnvironment

 *                                            (removes -d32 and -d64,

 *                                             determines desired data model,

 *                                             sets up LD_LIBRARY_PATH,

 *                                             and exec's)

 *                                             |

 *  --------------------------------------------

 *  |

 * \|/

 * exec child 1 incoming argv -----------------

 *  |                                          |

 * \|/                                         |

 * CheckJVMType                                |

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

 *  |                                         \|/

 *  |                                          CreateExecutionEnvironment

 *  |                                          (verifies desired data model

 *  |                                           is running and acceptable

 *  |                                           LD_LIBRARY_PATH;

 *  |                                           no-op in child)

 *  |

 * \|/

 * TranslateDashJArgs...

 * (Prepare to pass args to vm)

 *  |

 *  |

 *  |

 * \|/

 * ParseArguments

 * (ignores -d32 and -d64,

 *  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 *_argcp,

                           char ***_argvp,

                           char jrepath[],

                           jint so_jrepath,

                           char jvmpath[],

                           jint so_jvmpath,

                           char **original_argv) {

  /*

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

   */

    int original_argc = *_argcp;

    jboolean jvmpathExists;

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

    SetExecname(*_argvp);

    /* Set the LD_LIBRARY_PATH environment variable, check data model

       flags, and exec process, if needed */

    {

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

      char * jvmtype    = NULL;

      int argc          = *_argcp;

      char **argv       = original_argv;

      char *runpath     = NULL; /* existing effective LD_LIBRARY_PATH

                                   setting */

      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* new_runpath = NULL; /* desired new LD_LIBRARY_PATH string */

      char* newpath     = NULL; /* path on new LD_LIBRARY_PATH */

      char* lastslash   = NULL;

      char** newenvp    = NULL; /* current environment */

      char** newargv    = NULL;

      int    newargc    = 0;

#ifdef __solaris__

      char*  dmpath     = NULL;  /* data model specific LD_LIBRARY_PATH,

                                    Solaris only */

#endif

      /*

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

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

          exit(2);

        }

        /* Find the specified JVM type */

        if (ReadKnownVMs(jrepath, arch, JNI_FALSE) < 1) {

          exit(1);

        }

        jvmpath[0] = '\0';

        jvmtype = CheckJvmType(_argcp, _argvp, JNI_FALSE);

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

          exit(4);

        }

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

            goto EndDataModelSpeculate;

          }

          /*

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

           * selection options.

           */

          if (ReadKnownVMs(jrepath, GetArchPath(wanted), JNI_TRUE) < 1) {

            goto EndDataModelSpeculate;

          }

          jvmpath[0] = '\0';

          jvmtype = CheckJvmType(_argcp, _argvp, JNI_TRUE);

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

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

        }

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

        ;

#else

        exit(1);

#endif

      }

      /*

       * We will set the LD_LIBRARY_PATH as follows:

       *

       *     o          $JVMPATH (directory portion only)

       *     o          $JRE/lib/$LIBARCHNAME

       *     o          $JRE/../lib/$LIBARCHNAME

       *

       * followed by the user's previous effective LD_LIBRARY_PATH, if

       * any.

       */

#ifdef __solaris__

      /*

       * Starting in Solaris 7, ld.so.1 supports three LD_LIBRARY_PATH

       * variables:

       *

       * 1. LD_LIBRARY_PATH -- used for 32 and 64 bit searches if

       * data-model specific variables are not set.

       *

       * 2. LD_LIBRARY_PATH_64 -- overrides and replaces LD_LIBRARY_PATH

       * for 64-bit binaries.

       *

       * 3. LD_LIBRARY_PATH_32 -- overrides and replaces LD_LIBRARY_PATH

       * for 32-bit binaries.

       *

       * The vm uses LD_LIBRARY_PATH to set the java.library.path system

       * property.  To shield the vm from the complication of multiple

       * LD_LIBRARY_PATH variables, if the appropriate data model

       * specific variable is set, we will act as if LD_LIBRARY_PATH had

       * the value of the data model specific variant and the data model

       * specific variant will be unset.  Note that the variable for the

       * *wanted* data model must be used (if it is set), not simply the

       * current running data model.

       */

      switch(wanted) {

      case 0:

        if(running == 32) {

          dmpath = getenv("LD_LIBRARY_PATH_32");

          wanted = 32;

        }

        else {

          dmpath = getenv("LD_LIBRARY_PATH_64");

          wanted = 64;

        }

        break;

      case 32:

        dmpath = getenv("LD_LIBRARY_PATH_32");

        break;

      case 64:

        dmpath = getenv("LD_LIBRARY_PATH_64");

        break;

      default:

        exit(1); /* unknown value in wanted */

        break;

      }

      /*

       * If dmpath is NULL, the relevant data model specific variable is

       * not set and normal LD_LIBRARY_PATH should be used.

       */

      if( dmpath == NULL) {

        runpath = getenv("LD_LIBRARY_PATH");

      }

      else {

        runpath = dmpath;

      }

#else

      /*

       * If not on Solaris, assume only a single LD_LIBRARY_PATH

       * variable.

       */

      runpath = getenv("LD_LIBRARY_PATH");

#endif /* __solaris__ */

#ifdef __linux

      /*

       * On linux, if a binary is running as sgid or suid, glibc sets

       * LD_LIBRARY_PATH to the empty string for security purposes.  (In

       * contrast, on Solaris the LD_LIBRARY_PATH variable for a

       * privileged binary does not lose its settings; but the dynamic

       * linker does apply more scrutiny to the path.) The launcher uses

       * the value of LD_LIBRARY_PATH to prevent an exec loop.

       * Therefore, if we are running sgid or suid, this function's

       * setting of LD_LIBRARY_PATH will be ineffective and we should

       * return from the function now.  Getting the right libraries to

       * be found must be handled through other mechanisms.

       */

      if((getgid() != getegid()) || (getuid() != geteuid()) ) {

        return;

      }

#endif

      /* runpath contains current effective LD_LIBRARY_PATH setting */

      jvmpath = JLI_StringDup(jvmpath);

      new_runpath = JLI_MemAlloc( ((runpath!=NULL)?JLI_StrLen(runpath):0) +

                              2*JLI_StrLen(jrepath) + 2*JLI_StrLen(arch) +

                              JLI_StrLen(jvmpath) + 52);

      newpath = new_runpath + JLI_StrLen("LD_LIBRARY_PATH=");

      /*

       * Create desired LD_LIBRARY_PATH value for target data model.

       */

      {

        /* remove the name of the .so from the JVM path */

        lastslash = JLI_StrRChr(jvmpath, '/');

        if (lastslash)

          *lastslash = '\0';

        /* jvmpath, ((running != wanted)?((wanted==64)?"/"LIBARCH64NAME:"/.."):""), */

        sprintf(new_runpath, "LD_LIBRARY_PATH="

                "%s:"

                "%s/lib/%s:"

                "%s/../lib/%s",

                jvmpath,

#ifdef DUAL_MODE

                jrepath, GetArchPath(wanted),

                jrepath, GetArchPath(wanted)

#else

                jrepath, arch,

                jrepath, arch

#endif

                );

        /*

         * Check to make sure that the prefix of the current path is the

         * desired environment variable setting.

         */

        if (runpath != NULL &&

            JLI_StrNCmp(newpath, runpath, JLI_StrLen(newpath))==0 &&

            (runpath[JLI_StrLen(newpath)] == 0 || runpath[JLI_StrLen(newpath)] == ':') &&

            (running == wanted) /* data model does not have to be changed */

#ifdef __solaris__

            && (dmpath == NULL)    /* data model specific variables not set  */

#endif

            ) {

          return;

        }

      }

      /*

       * Place the desired environment setting onto the prefix of

       * LD_LIBRARY_PATH.  Note that this prevents any possible infinite

       * loop of execv() because we test for the prefix, above.

       */

      if (runpath != 0) {

        JLI_StrCat(new_runpath, ":");

        JLI_StrCat(new_runpath, runpath);

      }

      if( putenv(new_runpath) != 0) {

        exit(1); /* problem allocating memory; LD_LIBRARY_PATH not set

                    properly */

      }

      /*

       * Unix systems document that they look at LD_LIBRARY_PATH only

       * once at startup, so we have to re-exec the current executable

       * to get the changed environment variable to have an effect.

       */

#ifdef __solaris__

      /*

       * If dmpath is not NULL, remove the data model specific string

       * in the environment for the exec'ed child.

       */

      if( dmpath != NULL)

        (void)UnsetEnv((wanted==32)?"LD_LIBRARY_PATH_32":"LD_LIBRARY_PATH_64");

#endif

      newenvp = environ;

      {

        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