/*

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

#define JVM_DLL "libjvm.so"

#define JAVA_DLL "libjava.so"

#ifdef AIX

#define LD_LIBRARY_PATH "LIBPATH"

#else

#define LD_LIBRARY_PATH "LD_LIBRARY_PATH"

#endif

/* help jettison the LD_LIBRARY_PATH settings in the future */

#ifndef SETENV_REQUIRED

#define SETENV_REQUIRED

#endif

#ifdef __solaris__

#  ifndef LIBARCHNAME

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

#  endif

#  include <sys/systeminfo.h>

#  include <sys/elf.h>

#  include <stdio.h>

#endif

/*

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

 *

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

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

 * $RPATH/$ORIGIN 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.

 *

 * However, if the environment contains a LD_LIBRARY_PATH, this will cause the

 * launcher to inspect the LD_LIBRARY_PATH. The launcher will check

 *  a. if the LD_LIBRARY_PATH's first component is the path to the desired

 *     libjvm.so

 *  b. if any other libjvm.so is found in any of the paths.

 * If case b is true, then the launcher will set the LD_LIBRARY_PATH to the

 * desired JRE and reexec, in order to propagate the environment.

 *

 *  Main

 *  (incoming argv)

 *  |

 * \|/

 * CreateExecutionEnvironment

 * (determines desired data model)

 *  |

 *  |

 * \|/

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

 *  |

 *  |

 * \|/

 * YES

 *  |

 *  |

 * \|/

 * CheckJvmType

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

 *   |

 *   |

 *  \|/

 * RequiresSetenv

 * Is LD_LIBRARY_PATH

 * and friends set ? --> NO --> Have Desired Model ? NO --> Error/Exit

 *  YES                              YES --> Continue

 *   |

 *   |

 *  \|/

 * Path is desired JRE ? YES --> Have Desired Model ? NO --> Error/Exit

 *  NO                               YES --> Continue

 *   |

 *   |

 *  \|/

 * Paths have well known

 * jvm paths ?       --> NO --> Have Desired Model ? NO --> Error/Exit

 *  YES                              YES --> Continue

 *   |

 *   |

 *  \|/

 *  Does libjvm.so exit

 *  in any of them ? --> NO --> Have Desired Model ? NO --> Error/Exit

 *   YES                             YES --> Continue

 *   |

 *   |

 *  \|/

 *  Set the LD_LIBRARY_PATH

 *   |

 *   |

 *  \|/

 * Re-exec

 *   |

 *   |

 *  \|/

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

}

#ifdef SETENV_REQUIRED

static jboolean

JvmExists(const char *path) {

    char tmp[PATH_MAX + 1];

    struct stat statbuf;

    JLI_Snprintf(tmp, PATH_MAX, "%s/%s", path, JVM_DLL);

    if (stat(tmp, &statbuf) == 0) {

        return JNI_TRUE;

    }

    return JNI_FALSE;

}

/*

 * contains a lib/$LIBARCHNAME/{server,client}/libjvm.so ?

 */

static jboolean

ContainsLibJVM(const char *env) {

    char clientPattern[PATH_MAX + 1];

    char serverPattern[PATH_MAX + 1];

    char *envpath;

    char *path;

    jboolean clientPatternFound;

    jboolean serverPatternFound;

    /* fastest path */

    if (env == NULL) {

        return JNI_FALSE;

    }

    /* the usual suspects */

    JLI_Snprintf(clientPattern, PATH_MAX, "lib/%s/client", LIBARCHNAME);

    JLI_Snprintf(serverPattern, PATH_MAX, "lib/%s/server", LIBARCHNAME);

    /* to optimize for time, test if any of our usual suspects are present. */

    clientPatternFound = JLI_StrStr(env, clientPattern) != NULL;

    serverPatternFound = JLI_StrStr(env, serverPattern) != NULL;

    if (clientPatternFound == JNI_FALSE && serverPatternFound == JNI_FALSE) {

        return JNI_FALSE;

    }

    /*

     * we have a suspicious path component, check if it contains a libjvm.so

     */

    envpath = JLI_StringDup(env);

    for (path = JLI_StrTok(envpath, ":"); path != NULL; path = JLI_StrTok(NULL, ":")) {

        if (clientPatternFound && JLI_StrStr(path, clientPattern) != NULL) {

            if (JvmExists(path)) {

                JLI_MemFree(envpath);

                return JNI_TRUE;

            }

        }

        if (serverPatternFound && JLI_StrStr(path, serverPattern)  != NULL) {

            if (JvmExists(path)) {

                JLI_MemFree(envpath);

                return JNI_TRUE;

            }

        }

    }

    JLI_MemFree(envpath);

    return JNI_FALSE;

}

/*

 * Test whether the environment variable needs to be set, see flowchart.

 */

static jboolean

RequiresSetenv(const char *jvmpath) {

    char jpath[PATH_MAX + 1];

    char *llp;

    char *dmllp = NULL;

    char *p; /* a utility pointer */

#ifdef AIX

    /* We always have to set the LIBPATH on AIX because ld doesn't support $ORIGIN. */

    return JNI_TRUE;

#endif

    llp = getenv("LD_LIBRARY_PATH");

#ifdef __solaris__

    dmllp = getenv("LD_LIBRARY_PATH_64");

#endif /* __solaris__ */

    /* no environment variable is a good environment variable */

    if (llp == NULL && dmllp == NULL) {

        return JNI_FALSE;

    }

#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, here and further downstream. Therefore, if we are running sgid or

     * suid, this function's setting of LD_LIBRARY_PATH will be ineffective and

     * we should case a return from the calling function.  Getting the right

     * libraries will be handled by the RPATH. In reality, this check is

     * redundant, as the previous check for a non-null LD_LIBRARY_PATH will

     * return back to the calling function forthwith, it is left here to safe

     * guard against any changes, in the glibc's existing security policy.

     */

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

        return JNI_FALSE;

    }

#endif /* __linux */

    /*

     * Prevent recursions. Since LD_LIBRARY_PATH is the one which will be set by

     * previous versions of the JRE, thus it is the only path that matters here.

     * So we check to see if the desired JRE is set.

     */

    JLI_StrNCpy(jpath, jvmpath, PATH_MAX);

    p = JLI_StrRChr(jpath, '/');

    *p = '\0';

    if (llp != NULL && JLI_StrNCmp(llp, jpath, JLI_StrLen(jpath)) == 0) {

        return JNI_FALSE;

    }

    /* scrutinize all the paths further */

    if (llp != NULL &&  ContainsLibJVM(llp)) {

        return JNI_TRUE;

    }

    if (dmllp != NULL && ContainsLibJVM(dmllp)) {

        return JNI_TRUE;

    }

    return JNI_FALSE;

}

#endif /* SETENV_REQUIRED */

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, otherwise we simply exit with an error, as we no longer

   * support dual data models.

   */

    jboolean jvmpathExists;

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

    SetExecname(*pargv);

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

    {

      char *arch        = LIBARCHNAME; /* like sparc or sparcv9 */

      char * jvmtype    = NULL;

      int  argc         = *pargc;

      char **argv       = *pargv;

      int running       = CURRENT_DATA_MODEL;

      /*

       * As of jdk9, there is no support for dual mode operations, however

       * for legacy error reporting purposes and until -d options are supported

       * we need this.

       */

      int wanted        = running;

#ifdef SETENV_REQUIRED

      jboolean mustsetenv = JNI_FALSE;

      char *runpath     = NULL; /* existing effective LD_LIBRARY_PATH setting */

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

#ifdef __solaris__

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

                                    Solaris only */

#endif /* __solaris__ */

#endif  /* SETENV_REQUIRED */

      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,  arch, 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, 0 )) {

          JLI_ReportErrorMessage(CFG_ERROR8, jvmtype, jvmpath);

          exit(4);

        }

        /*

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

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

         */

#ifdef SETENV_REQUIRED

        mustsetenv = RequiresSetenv(jvmpath);

        JLI_TraceLauncher("mustsetenv: %s\n", mustsetenv ? "TRUE" : "FALSE");

        if (mustsetenv == JNI_FALSE) {

            JLI_MemFree(newargv);

            return;

        }

#else

            JLI_MemFree(newargv);

            return;

#endif /* SETENV_REQUIRED */

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

        JLI_ReportErrorMessage(JRE_ERROR2, wanted);

        exit(1);

    }

#ifdef SETENV_REQUIRED

        if (mustsetenv) {

            /*

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

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

                case 64:

                    dmpath = getenv("LD_LIBRARY_PATH_64");

                    wanted = 64;

                    break;

                default:

                    JLI_ReportErrorMessage(JRE_ERROR3, __LINE__);

                    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 /* ! __solaris__ */

            /*

             * If not on Solaris, assume only a single LD_LIBRARY_PATH

             * variable.

             */

            runpath = getenv(LD_LIBRARY_PATH);

#endif /* __solaris__ */

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

#ifdef AIX