1/*
2 * Copyright (c) 1998, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26#ifndef _JAVA_H_
27#define _JAVA_H_
28
29#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
32#include <limits.h>
33
34#include <jni.h>
35#include <jvm.h>
36
37/*
38 * Get system specific defines.
39 */
40#include "emessages.h"
41#include "java_md.h"
42#include "jli_util.h"
43#include "manifest_info.h"
44#include "wildcard.h"
45#include "splashscreen.h"
46
47# define KB (1024UL)
48# define MB (1024UL * KB)
49# define GB (1024UL * MB)
50
51#define CURRENT_DATA_MODEL (CHAR_BIT * sizeof(void*))
52
53/*
54 * The following environment variable is used to influence the behavior
55 * of the jre exec'd through the SelectVersion routine.  The command line
56 * options which specify the version are not passed to the exec'd version,
57 * because that jre may be an older version which wouldn't recognize them.
58 * This environment variable is known to this (and later) version and serves
59 * to suppress the version selection code.  This is not only for efficiency,
60 * but also for correctness, since any command line options have been
61 * removed which would cause any value found in the manifest to be used.
62 * This would be incorrect because the command line options are defined
63 * to take precedence.
64 *
65 * The value associated with this environment variable is the MainClass
66 * name from within the executable jar file (if any). This is strictly a
67 * performance enhancement to avoid re-reading the jar file manifest.
68 *
69 */
70#define ENV_ENTRY "_JAVA_VERSION_SET"
71
72#define SPLASH_FILE_ENV_ENTRY "_JAVA_SPLASH_FILE"
73#define SPLASH_JAR_ENV_ENTRY "_JAVA_SPLASH_JAR"
74#define JDK_JAVA_OPTIONS "JDK_JAVA_OPTIONS"
75
76/*
77 * Pointers to the needed JNI invocation API, initialized by LoadJavaVM.
78 */
79typedef jint (JNICALL *CreateJavaVM_t)(JavaVM **pvm, void **env, void *args);
80typedef jint (JNICALL *GetDefaultJavaVMInitArgs_t)(void *args);
81typedef jint (JNICALL *GetCreatedJavaVMs_t)(JavaVM **vmBuf, jsize bufLen, jsize *nVMs);
82
83typedef struct {
84    CreateJavaVM_t CreateJavaVM;
85    GetDefaultJavaVMInitArgs_t GetDefaultJavaVMInitArgs;
86    GetCreatedJavaVMs_t GetCreatedJavaVMs;
87} InvocationFunctions;
88
89int
90JLI_Launch(int argc, char ** argv,              /* main argc, argc */
91        int jargc, const char** jargv,          /* java args */
92        int appclassc, const char** appclassv,  /* app classpath */
93        const char* fullversion,                /* full version defined */
94        const char* dotversion,                 /* dot version defined */
95        const char* pname,                      /* program name */
96        const char* lname,                      /* launcher name */
97        jboolean javaargs,                      /* JAVA_ARGS */
98        jboolean cpwildcard,                    /* classpath wildcard */
99        jboolean javaw,                         /* windows-only javaw */
100        jint     ergo_class                     /* ergnomics policy */
101);
102
103/*
104 * Prototypes for launcher functions in the system specific java_md.c.
105 */
106
107jboolean
108LoadJavaVM(const char *jvmpath, InvocationFunctions *ifn);
109
110void
111GetXUsagePath(char *buf, jint bufsize);
112
113jboolean
114GetApplicationHome(char *buf, jint bufsize);
115
116jboolean
117GetApplicationHomeFromDll(char *buf, jint bufsize);
118
119#define GetArch() GetArchPath(CURRENT_DATA_MODEL)
120
121/*
122 * Different platforms will implement this, here
123 * pargc is a pointer to the original argc,
124 * pargv is a pointer to the original argv,
125 * jrepath is an accessible path to the jre as determined by the call
126 * so_jrepath is the length of the buffer jrepath
127 * jvmpath is an accessible path to the jvm as determined by the call
128 * so_jvmpath is the length of the buffer jvmpath
129 */
130void CreateExecutionEnvironment(int *argc, char ***argv,
131                                char *jrepath, jint so_jrepath,
132                                char *jvmpath, jint so_jvmpath,
133                                char *jvmcfg,  jint so_jvmcfg);
134
135/* Reports an error message to stderr or a window as appropriate. */
136void JLI_ReportErrorMessage(const char * message, ...);
137
138/* Reports a system error message to stderr or a window */
139void JLI_ReportErrorMessageSys(const char * message, ...);
140
141/* Reports an error message only to stderr. */
142void JLI_ReportMessage(const char * message, ...);
143
144/* Reports a message only to stdout. */
145void JLI_ShowMessage(const char * message, ...);
146
147/*
148 * Reports an exception which terminates the vm to stderr or a window
149 * as appropriate.
150 */
151void JLI_ReportExceptionDescription(JNIEnv * env);
152void PrintMachineDependentOptions();
153
154/*
155 * Block current thread and continue execution in new thread
156 */
157int ContinueInNewThread0(int (JNICALL *continuation)(void *),
158                        jlong stack_size, void * args);
159
160/* sun.java.launcher.* platform properties. */
161void SetJavaLauncherPlatformProps(void);
162void SetJavaCommandLineProp(char* what, int argc, char** argv);
163void SetJavaLauncherProp(void);
164
165/*
166 * Functions defined in java.c and used in java_md.c.
167 */
168jint ReadKnownVMs(const char *jvmcfg, jboolean speculative);
169char *CheckJvmType(int *argc, char ***argv, jboolean speculative);
170void AddOption(char *str, void *info);
171jboolean IsWhiteSpaceOption(const char* name);
172
173// Utility function defined in args.c
174int isTerminalOpt(char *arg);
175
176const char* GetProgramName();
177const char* GetFullVersion();
178jboolean IsJavaArgs();
179jboolean IsJavaw();
180
181int ContinueInNewThread(InvocationFunctions* ifn, jlong threadStackSize,
182                   int argc, char** argv,
183                   int mode, char *what, int ret);
184
185int JVMInit(InvocationFunctions* ifn, jlong threadStackSize,
186                   int argc, char** argv,
187                   int mode, char *what, int ret);
188
189/*
190 * Initialize platform specific settings
191 */
192void InitLauncher(jboolean javaw);
193
194/*
195 * For MacOSX and Windows/Unix compatibility we require these
196 * entry points, some of them may be stubbed out on Windows/Unixes.
197 */
198void     PostJVMInit(JNIEnv *env, jclass mainClass, JavaVM *vm);
199void     ShowSplashScreen();
200void     RegisterThread();
201/*
202 * this method performs additional platform specific processing and
203 * should return JNI_TRUE to indicate the argument has been consumed,
204 * otherwise returns JNI_FALSE to allow the calling logic to further
205 * process the option.
206 */
207jboolean ProcessPlatformOption(const char *arg);
208
209/*
210 * This allows for finding classes from the VM's bootstrap class loader directly,
211 * FindClass uses the application class loader internally, this will cause
212 * unnecessary searching of the classpath for the required classes.
213 *
214 */
215typedef jclass (JNICALL FindClassFromBootLoader_t(JNIEnv *env,
216                                                  const char *name));
217jclass FindBootStrapClass(JNIEnv *env, const char *classname);
218
219jobjectArray CreateApplicationArgs(JNIEnv *env, char **strv, int argc);
220jobjectArray NewPlatformStringArray(JNIEnv *env, char **strv, int strc);
221jclass GetLauncherHelperClass(JNIEnv *env);
222
223int JNICALL JavaMain(void * args); /* entry point                  */
224
225enum LaunchMode {               // cf. sun.launcher.LauncherHelper
226    LM_UNKNOWN = 0,
227    LM_CLASS,
228    LM_JAR,
229    LM_MODULE
230};
231
232static const char *launchModeNames[]
233    = { "Unknown", "Main class", "JAR file", "Module" };
234
235typedef struct {
236    int    argc;
237    char **argv;
238    int    mode;
239    char  *what;
240    InvocationFunctions ifn;
241} JavaMainArgs;
242
243#define NULL_CHECK_RETURN_VALUE(NCRV_check_pointer, NCRV_return_value) \
244    do { \
245        if ((NCRV_check_pointer) == NULL) { \
246            JLI_ReportErrorMessage(JNI_ERROR); \
247            return NCRV_return_value; \
248        } \
249    } while (JNI_FALSE)
250
251#define NULL_CHECK0(NC0_check_pointer) \
252    NULL_CHECK_RETURN_VALUE(NC0_check_pointer, 0)
253
254#define NULL_CHECK(NC_check_pointer) \
255    NULL_CHECK_RETURN_VALUE(NC_check_pointer, )
256
257#define CHECK_EXCEPTION_RETURN_VALUE(CER_value) \
258    do { \
259        if ((*env)->ExceptionOccurred(env)) { \
260            return CER_value; \
261        } \
262    } while (JNI_FALSE)
263
264#define CHECK_EXCEPTION_RETURN() \
265    do { \
266        if ((*env)->ExceptionOccurred(env)) { \
267            return; \
268        } \
269    } while (JNI_FALSE)
270
271#endif /* _JAVA_H_ */
272