1/*
2 * Copyright (c) 1998, 2019, 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
89JNIEXPORT int JNICALL
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. */
136JNIEXPORT void JNICALL
137JLI_ReportErrorMessage(const char * message, ...);
138
139/* Reports a system error message to stderr or a window */
140JNIEXPORT void JNICALL
141JLI_ReportErrorMessageSys(const char * message, ...);
142
143/* Reports an error message only to stderr. */
144JNIEXPORT void JNICALL
145JLI_ReportMessage(const char * message, ...);
146
147/* Reports a message only to stdout. */
148void JLI_ShowMessage(const char * message, ...);
149
150/*
151 * Reports an exception which terminates the vm to stderr or a window
152 * as appropriate.
153 */
154JNIEXPORT void JNICALL
155JLI_ReportExceptionDescription(JNIEnv * env);
156void PrintMachineDependentOptions();
157
158/*
159 * Block current thread and continue execution in new thread.
160 */
161int CallJavaMainInNewThread(jlong stack_size, void* args);
162
163/* sun.java.launcher.* platform properties. */
164void SetJavaLauncherPlatformProps(void);
165void SetJavaCommandLineProp(char* what, int argc, char** argv);
166void SetJavaLauncherProp(void);
167
168/*
169 * Functions defined in java.c and used in java_md.c.
170 */
171jint ReadKnownVMs(const char *jvmcfg, jboolean speculative);
172char *CheckJvmType(int *argc, char ***argv, jboolean speculative);
173void AddOption(char *str, void *info);
174jboolean IsWhiteSpaceOption(const char* name);
175
176// Utility function defined in args.c
177int isTerminalOpt(char *arg);
178
179const char* GetProgramName();
180const char* GetFullVersion();
181jboolean IsJavaArgs();
182jboolean IsJavaw();
183
184int ContinueInNewThread(InvocationFunctions* ifn, jlong threadStackSize,
185 int argc, char** argv,
186 int mode, char *what, int ret);
187
188int JVMInit(InvocationFunctions* ifn, jlong threadStackSize,
189 int argc, char** argv,
190 int mode, char *what, int ret);
191
192/*
193 * Initialize platform specific settings
194 */
195void InitLauncher(jboolean javaw);
196
197/*
198 * For MacOSX and Windows/Unix compatibility we require these
199 * entry points, some of them may be stubbed out on Windows/Unixes.
200 */
201void PostJVMInit(JNIEnv *env, jclass mainClass, JavaVM *vm);
202void ShowSplashScreen();
203void RegisterThread();
204/*
205 * this method performs additional platform specific processing and
206 * should return JNI_TRUE to indicate the argument has been consumed,
207 * otherwise returns JNI_FALSE to allow the calling logic to further
208 * process the option.
209 */
210jboolean ProcessPlatformOption(const char *arg);
211
212/*
213 * This allows for finding classes from the VM's bootstrap class loader directly,
214 * FindClass uses the application class loader internally, this will cause
215 * unnecessary searching of the classpath for the required classes.
216 *
217 */
218typedef jclass (JNICALL FindClassFromBootLoader_t(JNIEnv *env,
219 const char *name));
220jclass FindBootStrapClass(JNIEnv *env, const char *classname);
221
222jobjectArray CreateApplicationArgs(JNIEnv *env, char **strv, int argc);
223jobjectArray NewPlatformStringArray(JNIEnv *env, char **strv, int strc);
224jclass GetLauncherHelperClass(JNIEnv *env);
225
226/*
227 * Entry point.
228 */
229int JavaMain(void* args);
230
231enum LaunchMode { // cf. sun.launcher.LauncherHelper
232 LM_UNKNOWN = 0,
233 LM_CLASS,
234 LM_JAR,
235 LM_MODULE,
236 LM_SOURCE
237};
238
239static const char *launchModeNames[]
240 = { "Unknown", "Main class", "JAR file", "Module", "Source" };
241
242typedef struct {
243 int argc;
244 char **argv;
245 int mode;
246 char *what;
247 InvocationFunctions ifn;
248} JavaMainArgs;
249
250#define NULL_CHECK_RETURN_VALUE(NCRV_check_pointer, NCRV_return_value) \
251 do { \
252 if ((NCRV_check_pointer) == NULL) { \
253 JLI_ReportErrorMessage(JNI_ERROR); \
254 return NCRV_return_value; \
255 } \
256 } while (JNI_FALSE)
257
258#define NULL_CHECK0(NC0_check_pointer) \
259 NULL_CHECK_RETURN_VALUE(NC0_check_pointer, 0)
260
261#define NULL_CHECK(NC_check_pointer) \
262 NULL_CHECK_RETURN_VALUE(NC_check_pointer, )
263
264#define CHECK_EXCEPTION_RETURN_VALUE(CER_value) \
265 do { \
266 if ((*env)->ExceptionOccurred(env)) { \
267 return CER_value; \
268 } \
269 } while (JNI_FALSE)
270
271#define CHECK_EXCEPTION_RETURN() \
272 do { \
273 if ((*env)->ExceptionOccurred(env)) { \
274 return; \
275 } \
276 } while (JNI_FALSE)
277
278#endif /* _JAVA_H_ */
279