1 /*
2 * Copyright (c) 1997, 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 _JAVASOFT_JVM_H_
27 #define _JAVASOFT_JVM_H_
28
29 #include <sys/stat.h>
30
31 #include "jni.h"
32 #include "jvm_md.h"
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 /*
39 * This file contains additional functions exported from the VM.
40 * These functions are complementary to the standard JNI support.
41 * There are three parts to this file:
42 *
43 * First, this file contains the VM-related functions needed by native
44 * libraries in the standard Java API. For example, the java.lang.Object
45 * class needs VM-level functions that wait for and notify monitors.
46 *
47 * Second, this file contains the functions and constant definitions
48 * needed by the byte code verifier and class file format checker.
49 * These functions allow the verifier and format checker to be written
50 * in a VM-independent way.
51 *
52 * Third, this file contains various I/O and network operations needed
53 * by the standard Java I/O and network APIs.
54 */
55
56 /*
57 * Bump the version number when either of the following happens:
58 *
59 * 1. There is a change in JVM_* functions.
60 *
61 * 2. There is a change in the contract between VM and Java classes.
62 * For example, if the VM relies on a new private field in Thread
63 * class.
64 */
65
66 #define JVM_INTERFACE_VERSION 6
67
68 JNIEXPORT jint JNICALL
69 JVM_GetInterfaceVersion(void);
70
71 /*************************************************************************
72 PART 1: Functions for Native Libraries
73 ************************************************************************/
74 /*
75 * java.lang.Object
76 */
77 JNIEXPORT jint JNICALL
78 JVM_IHashCode(JNIEnv *env, jobject obj);
79
80 JNIEXPORT void JNICALL
81 JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);
82
83 JNIEXPORT void JNICALL
84 JVM_MonitorNotify(JNIEnv *env, jobject obj);
85
86 JNIEXPORT void JNICALL
87 JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);
88
89 JNIEXPORT jobject JNICALL
90 JVM_Clone(JNIEnv *env, jobject obj);
91
92 /*
93 * java.lang.String
94 */
95 JNIEXPORT jstring JNICALL
96 JVM_InternString(JNIEnv *env, jstring str);
97
98 /*
99 * java.lang.System
100 */
101 JNIEXPORT jlong JNICALL
102 JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);
103
104 JNIEXPORT jlong JNICALL
105 JVM_NanoTime(JNIEnv *env, jclass ignored);
106
107 JNIEXPORT jlong JNICALL
108 JVM_GetNanoTimeAdjustment(JNIEnv *env, jclass ignored, jlong offset_secs);
109
110 JNIEXPORT void JNICALL
111 JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,
112 jobject dst, jint dst_pos, jint length);
113
114 /*
115 * Return an array of all properties as alternating name and value pairs.
116 */
117 JNIEXPORT jobjectArray JNICALL
118 JVM_GetProperties(JNIEnv *env);
119
120 /*
121 * java.lang.Runtime
122 */
123 JNIEXPORT void JNICALL
124 JVM_BeforeHalt();
125
126 JNIEXPORT void JNICALL
127 JVM_Halt(jint code);
128
129 JNIEXPORT void JNICALL
130 JVM_GC(void);
131
132 /* Returns the number of real-time milliseconds that have elapsed since the
133 * least-recently-inspected heap object was last inspected by the garbage
134 * collector.
135 *
136 * For simple stop-the-world collectors this value is just the time
137 * since the most recent collection. For generational collectors it is the
138 * time since the oldest generation was most recently collected. Other
139 * collectors are free to return a pessimistic estimate of the elapsed time, or
140 * simply the time since the last full collection was performed.
141 *
142 * Note that in the presence of reference objects, a given object that is no
143 * longer strongly reachable may have to be inspected multiple times before it
144 * can be reclaimed.
145 */
146 JNIEXPORT jlong JNICALL
147 JVM_MaxObjectInspectionAge(void);
148
149 JNIEXPORT jlong JNICALL
150 JVM_TotalMemory(void);
151
152 JNIEXPORT jlong JNICALL
153 JVM_FreeMemory(void);
154
155 JNIEXPORT jlong JNICALL
156 JVM_MaxMemory(void);
157
158 JNIEXPORT jint JNICALL
159 JVM_ActiveProcessorCount(void);
160
161 JNIEXPORT void * JNICALL
162 JVM_LoadLibrary(const char *name);
163
164 JNIEXPORT void JNICALL
165 JVM_UnloadLibrary(void * handle);
166
167 JNIEXPORT void * JNICALL
168 JVM_FindLibraryEntry(void *handle, const char *name);
169
170 JNIEXPORT jboolean JNICALL
171 JVM_IsSupportedJNIVersion(jint version);
172
173 JNIEXPORT jobjectArray JNICALL
174 JVM_GetVmArguments(JNIEnv *env);
175
176 JNIEXPORT void JNICALL
177 JVM_InitializeFromArchive(JNIEnv* env, jclass cls);
178
179 /*
180 * java.lang.Throwable
181 */
182 JNIEXPORT void JNICALL
183 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
184
185 /*
186 * java.lang.StackTraceElement
187 */
188 JNIEXPORT void JNICALL
189 JVM_InitStackTraceElementArray(JNIEnv *env, jobjectArray elements, jobject throwable);
190
191 JNIEXPORT void JNICALL
192 JVM_InitStackTraceElement(JNIEnv* env, jobject element, jobject stackFrameInfo);
193
194 /*
195 * java.lang.NullPointerException
196 */
197
198 JNIEXPORT jstring JNICALL
199 JVM_GetExtendedNPEMessage(JNIEnv *env, jthrowable throwable);
200
201 /*
202 * java.lang.StackWalker
203 */
204 enum {
205 JVM_STACKWALK_FILL_CLASS_REFS_ONLY = 0x2,
206 JVM_STACKWALK_GET_CALLER_CLASS = 0x04,
207 JVM_STACKWALK_SHOW_HIDDEN_FRAMES = 0x20,
208 JVM_STACKWALK_FILL_LIVE_STACK_FRAMES = 0x100
209 };
210
211 JNIEXPORT jobject JNICALL
212 JVM_CallStackWalk(JNIEnv *env, jobject stackStream, jlong mode,
213 jint skip_frames, jint frame_count, jint start_index,
214 jobjectArray frames);
215
216 JNIEXPORT jint JNICALL
217 JVM_MoreStackWalk(JNIEnv *env, jobject stackStream, jlong mode, jlong anchor,
218 jint frame_count, jint start_index,
219 jobjectArray frames);
220
221 /*
222 * java.lang.Thread
223 */
224 JNIEXPORT void JNICALL
225 JVM_StartThread(JNIEnv *env, jobject thread);
226
227 JNIEXPORT void JNICALL
228 JVM_StopThread(JNIEnv *env, jobject thread, jobject exception);
229
230 JNIEXPORT jboolean JNICALL
231 JVM_IsThreadAlive(JNIEnv *env, jobject thread);
232
233 JNIEXPORT void JNICALL
234 JVM_SuspendThread(JNIEnv *env, jobject thread);
235
236 JNIEXPORT void JNICALL
237 JVM_ResumeThread(JNIEnv *env, jobject thread);
238
239 JNIEXPORT void JNICALL
240 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
241
242 JNIEXPORT void JNICALL
243 JVM_Yield(JNIEnv *env, jclass threadClass);
244
245 JNIEXPORT void JNICALL
246 JVM_Sleep(JNIEnv *env, jclass threadClass, jlong millis);
247
248 JNIEXPORT jobject JNICALL
249 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
250
251 JNIEXPORT jint JNICALL
252 JVM_CountStackFrames(JNIEnv *env, jobject thread);
253
254 JNIEXPORT void JNICALL
255 JVM_Interrupt(JNIEnv *env, jobject thread);
256
257 JNIEXPORT jboolean JNICALL
258 JVM_IsInterrupted(JNIEnv *env, jobject thread, jboolean clearInterrupted);
259
260 JNIEXPORT jboolean JNICALL
261 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
262
263 JNIEXPORT void JNICALL
264 JVM_DumpAllStacks(JNIEnv *env, jclass unused);
265
266 JNIEXPORT jobjectArray JNICALL
267 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
268
269 JNIEXPORT void JNICALL
270 JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);
271
272 /* getStackTrace() and getAllStackTraces() method */
273 JNIEXPORT jobjectArray JNICALL
274 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
275
276 /*
277 * java.lang.SecurityManager
278 */
279 JNIEXPORT jobjectArray JNICALL
280 JVM_GetClassContext(JNIEnv *env);
281
282 /*
283 * java.lang.Package
284 */
285 JNIEXPORT jstring JNICALL
286 JVM_GetSystemPackage(JNIEnv *env, jstring name);
287
288 JNIEXPORT jobjectArray JNICALL
289 JVM_GetSystemPackages(JNIEnv *env);
290
291 /*
292 * java.lang.ref.Reference
293 */
294 JNIEXPORT jobject JNICALL
295 JVM_GetAndClearReferencePendingList(JNIEnv *env);
296
297 JNIEXPORT jboolean JNICALL
298 JVM_HasReferencePendingList(JNIEnv *env);
299
300 JNIEXPORT void JNICALL
301 JVM_WaitForReferencePendingList(JNIEnv *env);
302
303 /*
304 * java.io.ObjectInputStream
305 */
306 JNIEXPORT jobject JNICALL
307 JVM_LatestUserDefinedLoader(JNIEnv *env);
308
309 /*
310 * java.lang.reflect.Array
311 */
312 JNIEXPORT jint JNICALL
313 JVM_GetArrayLength(JNIEnv *env, jobject arr);
314
315 JNIEXPORT jobject JNICALL
316 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
317
318 JNIEXPORT jvalue JNICALL
319 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
320
321 JNIEXPORT void JNICALL
322 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
323
324 JNIEXPORT void JNICALL
325 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
326 unsigned char vCode);
327
328 JNIEXPORT jobject JNICALL
329 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
330
331 JNIEXPORT jobject JNICALL
332 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
333
334
335 /*
336 * Returns the immediate caller class of the native method invoking
337 * JVM_GetCallerClass. The Method.invoke and other frames due to
338 * reflection machinery are skipped.
339 *
340 * The caller is expected to be marked with
341 * jdk.internal.reflect.CallerSensitive. The JVM will throw an
342 * error if it is not marked properly.
343 */
344 JNIEXPORT jclass JNICALL
345 JVM_GetCallerClass(JNIEnv *env);
346
347
348 /*
349 * Find primitive classes
350 * utf: class name
351 */
352 JNIEXPORT jclass JNICALL
353 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
354
355
356 /*
357 * Find a class from a boot class loader. Returns NULL if class not found.
358 */
359 JNIEXPORT jclass JNICALL
360 JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);
361
362 /*
363 * Find a class from a given class loader. Throws ClassNotFoundException.
364 * name: name of class
365 * init: whether initialization is done
366 * loader: class loader to look up the class. This may not be the same as the caller's
367 * class loader.
368 * caller: initiating class. The initiating class may be null when a security
369 * manager is not installed.
370 */
371 JNIEXPORT jclass JNICALL
372 JVM_FindClassFromCaller(JNIEnv *env, const char *name, jboolean init,
373 jobject loader, jclass caller);
374
375 /*
376 * Find a class from a given class.
377 */
378 JNIEXPORT jclass JNICALL
379 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
380 jclass from);
381
382 /* Find a loaded class cached by the VM */
383 JNIEXPORT jclass JNICALL
384 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
385
386 /* Define a class */
387 JNIEXPORT jclass JNICALL
388 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
389 jsize len, jobject pd);
390
391 /* Define a class with a source (added in JDK1.5) */
392 JNIEXPORT jclass JNICALL
393 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
394 const jbyte *buf, jsize len, jobject pd,
395 const char *source);
396
397 /*
398 * Module support funcions
399 */
400
401 /*
402 * Define a module with the specified packages and bind the module to the
403 * given class loader.
404 * module: module to define
405 * is_open: specifies if module is open (currently ignored)
406 * version: the module version
407 * location: the module location
408 * packages: list of packages in the module
409 * num_packages: number of packages in the module
410 */
411 JNIEXPORT void JNICALL
412 JVM_DefineModule(JNIEnv *env, jobject module, jboolean is_open, jstring version,
413 jstring location, const char* const* packages, jsize num_packages);
414
415 /*
416 * Set the boot loader's unnamed module.
417 * module: boot loader's unnamed module
418 */
419 JNIEXPORT void JNICALL
420 JVM_SetBootLoaderUnnamedModule(JNIEnv *env, jobject module);
421
422 /*
423 * Do a qualified export of a package.
424 * from_module: module containing the package to export
425 * package: name of the package to export
426 * to_module: module to export the package to
427 */
428 JNIEXPORT void JNICALL
429 JVM_AddModuleExports(JNIEnv *env, jobject from_module, const char* package, jobject to_module);
430
431 /*
432 * Do an export of a package to all unnamed modules.
433 * from_module: module containing the package to export
434 * package: name of the package to export to all unnamed modules
435 */
436 JNIEXPORT void JNICALL
437 JVM_AddModuleExportsToAllUnnamed(JNIEnv *env, jobject from_module, const char* package);
438
439 /*
440 * Do an unqualified export of a package.
441 * from_module: module containing the package to export
442 * package: name of the package to export
443 */
444 JNIEXPORT void JNICALL
445 JVM_AddModuleExportsToAll(JNIEnv *env, jobject from_module, const char* package);
446
447 /*
448 * Add a module to the list of modules that a given module can read.
449 * from_module: module requesting read access
450 * source_module: module that from_module wants to read
451 */
452 JNIEXPORT void JNICALL
453 JVM_AddReadsModule(JNIEnv *env, jobject from_module, jobject source_module);
454
455 /*
456 * Reflection support functions
457 */
458
459 JNIEXPORT jstring JNICALL
460 JVM_InitClassName(JNIEnv *env, jclass cls);
461
462 JNIEXPORT jobjectArray JNICALL
463 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
464
465 JNIEXPORT jboolean JNICALL
466 JVM_IsInterface(JNIEnv *env, jclass cls);
467
468 JNIEXPORT jobjectArray JNICALL
469 JVM_GetClassSigners(JNIEnv *env, jclass cls);
470
471 JNIEXPORT void JNICALL
472 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
473
474 JNIEXPORT jobject JNICALL
475 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
476
477 JNIEXPORT jboolean JNICALL
478 JVM_IsArrayClass(JNIEnv *env, jclass cls);
479
480 JNIEXPORT jboolean JNICALL
481 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
482
483 JNIEXPORT jint JNICALL
484 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
485
486 JNIEXPORT jobjectArray JNICALL
487 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
488
489 JNIEXPORT jclass JNICALL
490 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
491
492 JNIEXPORT jstring JNICALL
493 JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);
494
495 /* Generics support (JDK 1.5) */
496 JNIEXPORT jstring JNICALL
497 JVM_GetClassSignature(JNIEnv *env, jclass cls);
498
499 /* Annotations support (JDK 1.5) */
500 JNIEXPORT jbyteArray JNICALL
501 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
502
503 /* Type use annotations support (JDK 1.8) */
504
505 JNIEXPORT jbyteArray JNICALL
506 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
507
508 JNIEXPORT jbyteArray JNICALL
509 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
510
511 JNIEXPORT jbyteArray JNICALL
512 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
513
514 /*
515 * New (JDK 1.4) reflection implementation
516 */
517
518 JNIEXPORT jobjectArray JNICALL
519 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
520
521 JNIEXPORT jobjectArray JNICALL
522 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
523
524 JNIEXPORT jobjectArray JNICALL
525 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
526
527 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
528 This returns the access flags for the class as specified in the
529 class file rather than searching the InnerClasses attribute (if
530 present) to find the source-level access flags. Only the values of
531 the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
532 valid. */
533 JNIEXPORT jint JNICALL
534 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
535
536 /* Nestmates - since JDK 11 */
537
538 JNIEXPORT jboolean JNICALL
539 JVM_AreNestMates(JNIEnv *env, jclass current, jclass member);
540
541 JNIEXPORT jclass JNICALL
542 JVM_GetNestHost(JNIEnv *env, jclass current);
543
544 JNIEXPORT jobjectArray JNICALL
545 JVM_GetNestMembers(JNIEnv *env, jclass current);
546
547 /* The following two reflection routines are still needed due to startup time issues */
548 /*
549 * java.lang.reflect.Method
550 */
551 JNIEXPORT jobject JNICALL
552 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
553
554 /*
555 * java.lang.reflect.Constructor
556 */
557 JNIEXPORT jobject JNICALL
558 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
559
560 /*
561 * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
562 */
563
564 JNIEXPORT jobject JNICALL
565 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
566
567 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
568 (JNIEnv *env, jobject unused, jobject jcpool);
569
570 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
571 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
572
573 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
574 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
575
576 JNIEXPORT jint JNICALL JVM_ConstantPoolGetClassRefIndexAt
577 (JNIEnv *env, jobject obj, jobject unused, jint index);
578
579 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
580 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
581
582 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
583 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
584
585 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
586 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
587
588 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
589 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
590
591 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
592 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
593
594 JNIEXPORT jint JNICALL JVM_ConstantPoolGetNameAndTypeRefIndexAt
595 (JNIEnv *env, jobject obj, jobject unused, jint index);
596
597 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetNameAndTypeRefInfoAt
598 (JNIEnv *env, jobject obj, jobject unused, jint index);
599
600 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
601 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
602
603 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
604 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
605
606 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
607 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
608
609 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
610 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
611
612 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
613 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
614
615 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
616 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
617
618 JNIEXPORT jbyte JNICALL JVM_ConstantPoolGetTagAt
619 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
620
621 /*
622 * Parameter reflection
623 */
624
625 JNIEXPORT jobjectArray JNICALL
626 JVM_GetMethodParameters(JNIEnv *env, jobject method);
627
628 /*
629 * java.security.*
630 */
631
632 JNIEXPORT jobject JNICALL
633 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
634
635 /*
636 * Ensure that code doing a stackwalk and using javaVFrame::locals() to
637 * get the value will see a materialized value and not a scalar-replaced
638 * null value.
639 */
640 #define JVM_EnsureMaterializedForStackWalk(env, value) \
641 do {} while(0) // Nothing to do. The fact that the value escaped
642 // through a native method is enough.
643
644 JNIEXPORT jobject JNICALL
645 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
646
647 /*
648 * Signal support, used to implement the shutdown sequence. Every VM must
649 * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
650 * (^C) and the latter for external termination (kill, system shutdown, etc.).
651 * Other platform-dependent signal values may also be supported.
652 */
653
654 JNIEXPORT void * JNICALL
655 JVM_RegisterSignal(jint sig, void *handler);
656
657 JNIEXPORT jboolean JNICALL
658 JVM_RaiseSignal(jint sig);
659
660 JNIEXPORT jint JNICALL
661 JVM_FindSignal(const char *name);
662
663 /*
664 * Retrieve the assertion directives for the specified class.
665 */
666 JNIEXPORT jboolean JNICALL
667 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
668
669 /*
670 * Retrieve the assertion directives from the VM.
671 */
672 JNIEXPORT jobject JNICALL
673 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
674
675 /*
676 * java.util.concurrent.atomic.AtomicLong
677 */
678 JNIEXPORT jboolean JNICALL
679 JVM_SupportsCX8(void);
680
681 /*
682 * com.sun.dtrace.jsdt support
683 */
684
685 #define JVM_TRACING_DTRACE_VERSION 1
686
687 /*
688 * Structure to pass one probe description to JVM
689 */
690 typedef struct {
691 jmethodID method;
692 jstring function;
693 jstring name;
694 void* reserved[4]; // for future use
695 } JVM_DTraceProbe;
696
697 /**
698 * Encapsulates the stability ratings for a DTrace provider field
699 */
700 typedef struct {
701 jint nameStability;
702 jint dataStability;
703 jint dependencyClass;
704 } JVM_DTraceInterfaceAttributes;
705
706 /*
707 * Structure to pass one provider description to JVM
708 */
709 typedef struct {
710 jstring name;
711 JVM_DTraceProbe* probes;
712 jint probe_count;
713 JVM_DTraceInterfaceAttributes providerAttributes;
714 JVM_DTraceInterfaceAttributes moduleAttributes;
715 JVM_DTraceInterfaceAttributes functionAttributes;
716 JVM_DTraceInterfaceAttributes nameAttributes;
717 JVM_DTraceInterfaceAttributes argsAttributes;
718 void* reserved[4]; // for future use
719 } JVM_DTraceProvider;
720
721 /*
722 * Get the version number the JVM was built with
723 */
724 JNIEXPORT jint JNICALL
725 JVM_DTraceGetVersion(JNIEnv* env);
726
727 /*
728 * Register new probe with given signature, return global handle
729 *
730 * The version passed in is the version that the library code was
731 * built with.
732 */
733 JNIEXPORT jlong JNICALL
734 JVM_DTraceActivate(JNIEnv* env, jint version, jstring module_name,
735 jint providers_count, JVM_DTraceProvider* providers);
736
737 /*
738 * Check JSDT probe
739 */
740 JNIEXPORT jboolean JNICALL
741 JVM_DTraceIsProbeEnabled(JNIEnv* env, jmethodID method);
742
743 /*
744 * Destroy custom DOF
745 */
746 JNIEXPORT void JNICALL
747 JVM_DTraceDispose(JNIEnv* env, jlong activation_handle);
748
749 /*
750 * Check to see if DTrace is supported by OS
751 */
752 JNIEXPORT jboolean JNICALL
753 JVM_DTraceIsSupported(JNIEnv* env);
754
755 /*************************************************************************
756 PART 2: Support for the Verifier and Class File Format Checker
757 ************************************************************************/
758 /*
759 * Return the class name in UTF format. The result is valid
760 * until JVM_ReleaseUTf is called.
761 *
762 * The caller must treat the string as a constant and not modify it
763 * in any way.
764 */
765 JNIEXPORT const char * JNICALL
766 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
767
768 /*
769 * Returns the constant pool types in the buffer provided by "types."
770 */
771 JNIEXPORT void JNICALL
772 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
773
774 /*
775 * Returns the number of Constant Pool entries.
776 */
777 JNIEXPORT jint JNICALL
778 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
779
780 /*
781 * Returns the number of *declared* fields or methods.
782 */
783 JNIEXPORT jint JNICALL
784 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
785
786 JNIEXPORT jint JNICALL
787 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
788
789 /*
790 * Returns the CP indexes of exceptions raised by a given method.
791 * Places the result in the given buffer.
792 *
793 * The method is identified by method_index.
794 */
795 JNIEXPORT void JNICALL
796 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
797 unsigned short *exceptions);
798 /*
799 * Returns the number of exceptions raised by a given method.
800 * The method is identified by method_index.
801 */
802 JNIEXPORT jint JNICALL
803 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
804
805 /*
806 * Returns the byte code sequence of a given method.
807 * Places the result in the given buffer.
808 *
809 * The method is identified by method_index.
810 */
811 JNIEXPORT void JNICALL
812 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
813 unsigned char *code);
814
815 /*
816 * Returns the length of the byte code sequence of a given method.
817 * The method is identified by method_index.
818 */
819 JNIEXPORT jint JNICALL
820 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
821
822 /*
823 * A structure used to a capture exception table entry in a Java method.
824 */
825 typedef struct {
826 jint start_pc;
827 jint end_pc;
828 jint handler_pc;
829 jint catchType;
830 } JVM_ExceptionTableEntryType;
831
832 /*
833 * Returns the exception table entry at entry_index of a given method.
834 * Places the result in the given buffer.
835 *
836 * The method is identified by method_index.
837 */
838 JNIEXPORT void JNICALL
839 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
840 jint entry_index,
841 JVM_ExceptionTableEntryType *entry);
842
843 /*
844 * Returns the length of the exception table of a given method.
845 * The method is identified by method_index.
846 */
847 JNIEXPORT jint JNICALL
848 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
849
850 /*
851 * Returns the modifiers of a given field.
852 * The field is identified by field_index.
853 */
854 JNIEXPORT jint JNICALL
855 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
856
857 /*
858 * Returns the modifiers of a given method.
859 * The method is identified by method_index.
860 */
861 JNIEXPORT jint JNICALL
862 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
863
864 /*
865 * Returns the number of local variables of a given method.
866 * The method is identified by method_index.
867 */
868 JNIEXPORT jint JNICALL
869 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
870
871 /*
872 * Returns the number of arguments (including this pointer) of a given method.
873 * The method is identified by method_index.
874 */
875 JNIEXPORT jint JNICALL
876 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
877
878 /*
879 * Returns the maximum amount of stack (in words) used by a given method.
880 * The method is identified by method_index.
881 */
882 JNIEXPORT jint JNICALL
883 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
884
885 /*
886 * Is a given method a constructor.
887 * The method is identified by method_index.
888 */
889 JNIEXPORT jboolean JNICALL
890 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
891
892 /*
893 * Is the given method generated by the VM.
894 * The method is identified by method_index.
895 */
896 JNIEXPORT jboolean JNICALL
897 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
898
899 /*
900 * Returns the name of a given method in UTF format.
901 * The result remains valid until JVM_ReleaseUTF is called.
902 *
903 * The caller must treat the string as a constant and not modify it
904 * in any way.
905 */
906 JNIEXPORT const char * JNICALL
907 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
908
909 /*
910 * Returns the signature of a given method in UTF format.
911 * The result remains valid until JVM_ReleaseUTF is called.
912 *
913 * The caller must treat the string as a constant and not modify it
914 * in any way.
915 */
916 JNIEXPORT const char * JNICALL
917 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
918
919 /*
920 * Returns the name of the field referred to at a given constant pool
921 * index.
922 *
923 * The result is in UTF format and remains valid until JVM_ReleaseUTF
924 * is called.
925 *
926 * The caller must treat the string as a constant and not modify it
927 * in any way.
928 */
929 JNIEXPORT const char * JNICALL
930 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
931
932 /*
933 * Returns the name of the method referred to at a given constant pool
934 * index.
935 *
936 * The result is in UTF format and remains valid until JVM_ReleaseUTF
937 * is called.
938 *
939 * The caller must treat the string as a constant and not modify it
940 * in any way.
941 */
942 JNIEXPORT const char * JNICALL
943 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
944
945 /*
946 * Returns the signature of the method referred to at a given constant pool
947 * index.
948 *
949 * The result is in UTF format and remains valid until JVM_ReleaseUTF
950 * is called.
951 *
952 * The caller must treat the string as a constant and not modify it
953 * in any way.
954 */
955 JNIEXPORT const char * JNICALL
956 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
957
958 /*
959 * Returns the signature of the field referred to at a given constant pool
960 * index.
961 *
962 * The result is in UTF format and remains valid until JVM_ReleaseUTF
963 * is called.
964 *
965 * The caller must treat the string as a constant and not modify it
966 * in any way.
967 */
968 JNIEXPORT const char * JNICALL
969 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
970
971 /*
972 * Returns the class name referred to at a given constant pool index.
973 *
974 * The result is in UTF format and remains valid until JVM_ReleaseUTF
975 * is called.
976 *
977 * The caller must treat the string as a constant and not modify it
978 * in any way.
979 */
980 JNIEXPORT const char * JNICALL
981 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
982
983 /*
984 * Returns the class name referred to at a given constant pool index.
985 *
986 * The constant pool entry must refer to a CONSTANT_Fieldref.
987 *
988 * The result is in UTF format and remains valid until JVM_ReleaseUTF
989 * is called.
990 *
991 * The caller must treat the string as a constant and not modify it
992 * in any way.
993 */
994 JNIEXPORT const char * JNICALL
995 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
996
997 /*
998 * Returns the class name referred to at a given constant pool index.
999 *
1000 * The constant pool entry must refer to CONSTANT_Methodref or
1001 * CONSTANT_InterfaceMethodref.
1002 *
1003 * The result is in UTF format and remains valid until JVM_ReleaseUTF
1004 * is called.
1005 *
1006 * The caller must treat the string as a constant and not modify it
1007 * in any way.
1008 */
1009 JNIEXPORT const char * JNICALL
1010 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
1011
1012 /*
1013 * Returns the modifiers of a field in calledClass. The field is
1014 * referred to in class cb at constant pool entry index.
1015 *
1016 * The caller must treat the string as a constant and not modify it
1017 * in any way.
1018 *
1019 * Returns -1 if the field does not exist in calledClass.
1020 */
1021 JNIEXPORT jint JNICALL
1022 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1023
1024 /*
1025 * Returns the modifiers of a method in calledClass. The method is
1026 * referred to in class cb at constant pool entry index.
1027 *
1028 * Returns -1 if the method does not exist in calledClass.
1029 */
1030 JNIEXPORT jint JNICALL
1031 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1032
1033 /*
1034 * Releases the UTF string obtained from the VM.
1035 */
1036 JNIEXPORT void JNICALL
1037 JVM_ReleaseUTF(const char *utf);
1038
1039 /*
1040 * Compare if two classes are in the same package.
1041 */
1042 JNIEXPORT jboolean JNICALL
1043 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
1044
1045 /* Get classfile constants */
1046 #include "classfile_constants.h"
1047
1048 /*
1049 * Support for a VM-independent class format checker.
1050 */
1051 typedef struct {
1052 unsigned long code; /* byte code */
1053 unsigned long excs; /* exceptions */
1054 unsigned long etab; /* catch table */
1055 unsigned long lnum; /* line number */
1056 unsigned long lvar; /* local vars */
1057 } method_size_info;
1058
1059 typedef struct {
1060 unsigned int constants; /* constant pool */
1061 unsigned int fields;
1062 unsigned int methods;
1063 unsigned int interfaces;
1064 unsigned int fields2; /* number of static 2-word fields */
1065 unsigned int innerclasses; /* # of records in InnerClasses attr */
1066
1067 method_size_info clinit; /* memory used in clinit */
1068 method_size_info main; /* used everywhere else */
1069 } class_size_info;
1070
1071 /*
1072 * Functions defined in libjava.so to perform string conversions.
1073 *
1074 */
1075
1076 typedef jstring (*to_java_string_fn_t)(JNIEnv *env, char *str);
1077
1078 #define JVM_RECOGNIZED_CLASS_MODIFIERS (JVM_ACC_PUBLIC | \
1079 JVM_ACC_FINAL | \
1080 JVM_ACC_SUPER | \
1081 JVM_ACC_INTERFACE | \
1082 JVM_ACC_ABSTRACT | \
1083 JVM_ACC_ANNOTATION | \
1084 JVM_ACC_ENUM | \
1085 JVM_ACC_SYNTHETIC)
1086
1087 #define JVM_RECOGNIZED_FIELD_MODIFIERS (JVM_ACC_PUBLIC | \
1088 JVM_ACC_PRIVATE | \
1089 JVM_ACC_PROTECTED | \
1090 JVM_ACC_STATIC | \
1091 JVM_ACC_FINAL | \
1092 JVM_ACC_VOLATILE | \
1093 JVM_ACC_TRANSIENT | \
1094 JVM_ACC_ENUM | \
1095 JVM_ACC_SYNTHETIC)
1096
1097 #define JVM_RECOGNIZED_METHOD_MODIFIERS (JVM_ACC_PUBLIC | \
1098 JVM_ACC_PRIVATE | \
1099 JVM_ACC_PROTECTED | \
1100 JVM_ACC_STATIC | \
1101 JVM_ACC_FINAL | \
1102 JVM_ACC_SYNCHRONIZED | \
1103 JVM_ACC_BRIDGE | \
1104 JVM_ACC_VARARGS | \
1105 JVM_ACC_NATIVE | \
1106 JVM_ACC_ABSTRACT | \
1107 JVM_ACC_STRICT | \
1108 JVM_ACC_SYNTHETIC)
1109
1110 /*
1111 * This is the function defined in libjava.so to perform path
1112 * canonicalization. VM call this function before opening jar files
1113 * to load system classes.
1114 *
1115 */
1116
1117 typedef int (*canonicalize_fn_t)(JNIEnv *env, char *orig, char *out, int len);
1118
1119 /*************************************************************************
1120 PART 3: I/O and Network Support
1121 ************************************************************************/
1122
1123 /*
1124 * Convert a pathname into native format. This function does syntactic
1125 * cleanup, such as removing redundant separator characters. It modifies
1126 * the given pathname string in place.
1127 */
1128 JNIEXPORT char * JNICALL
1129 JVM_NativePath(char *);
1130
1131 /*
1132 * The standard printing functions supported by the Java VM. (Should they
1133 * be renamed to JVM_* in the future?
1134 */
1135
1136 /* jio_snprintf() and jio_vsnprintf() behave like snprintf(3) and vsnprintf(3),
1137 * respectively, with the following differences:
1138 * - The string written to str is always zero-terminated, also in case of
1139 * truncation (count is too small to hold the result string), unless count
1140 * is 0. In case of truncation count-1 characters are written and '\0'
1141 * appendend.
1142 * - If count is too small to hold the whole string, -1 is returned across
1143 * all platforms. */
1144
1145 JNIEXPORT int
1146 jio_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1147
1148 JNIEXPORT int
1149 jio_snprintf(char *str, size_t count, const char *fmt, ...);
1150
1151 JNIEXPORT int
1152 jio_fprintf(FILE *, const char *fmt, ...);
1153
1154 JNIEXPORT int
1155 jio_vfprintf(FILE *, const char *fmt, va_list args);
1156
1157
1158 JNIEXPORT void * JNICALL
1159 JVM_RawMonitorCreate(void);
1160
1161 JNIEXPORT void JNICALL
1162 JVM_RawMonitorDestroy(void *mon);
1163
1164 JNIEXPORT jint JNICALL
1165 JVM_RawMonitorEnter(void *mon);
1166
1167 JNIEXPORT void JNICALL
1168 JVM_RawMonitorExit(void *mon);
1169
1170 /*
1171 * java.lang.management support
1172 */
1173 JNIEXPORT void* JNICALL
1174 JVM_GetManagement(jint version);
1175
1176 /*
1177 * com.sun.tools.attach.VirtualMachine support
1178 *
1179 * Initialize the agent properties with the properties maintained in the VM.
1180 */
1181 JNIEXPORT jobject JNICALL
1182 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
1183
1184 JNIEXPORT jstring JNICALL
1185 JVM_GetTemporaryDirectory(JNIEnv *env);
1186
1187 /* Generics reflection support.
1188 *
1189 * Returns information about the given class's EnclosingMethod
1190 * attribute, if present, or null if the class had no enclosing
1191 * method.
1192 *
1193 * If non-null, the returned array contains three elements. Element 0
1194 * is the java.lang.Class of which the enclosing method is a member,
1195 * and elements 1 and 2 are the java.lang.Strings for the enclosing
1196 * method's name and descriptor, respectively.
1197 */
1198 JNIEXPORT jobjectArray JNICALL
1199 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
1200
1201 /* =========================================================================
1202 * The following defines a private JVM interface that the JDK can query
1203 * for the JVM version and capabilities. sun.misc.Version defines
1204 * the methods for getting the VM version and its capabilities.
1205 *
1206 * When a new bit is added, the following should be updated to provide
1207 * access to the new capability:
1208 * HS: JVM_GetVersionInfo and Abstract_VM_Version class
1209 * SDK: Version class
1210 *
1211 * Similary, a private JDK interface JDK_GetVersionInfo0 is defined for
1212 * JVM to query for the JDK version and capabilities.
1213 *
1214 * When a new bit is added, the following should be updated to provide
1215 * access to the new capability:
1216 * HS: JDK_Version class
1217 * SDK: JDK_GetVersionInfo0
1218 *
1219 * ==========================================================================
1220 */
1221 typedef struct {
1222 unsigned int jvm_version; /* Encoded $VNUM as specified by JEP-223 */
1223 unsigned int patch_version : 8; /* JEP-223 patch version */
1224 unsigned int reserved3 : 8;
1225 unsigned int reserved1 : 16;
1226 unsigned int reserved2;
1227
1228 /* The following bits represents JVM supports that JDK has dependency on.
1229 * JDK can use these bits to determine which JVM version
1230 * and support it has to maintain runtime compatibility.
1231 *
1232 * When a new bit is added in a minor or update release, make sure
1233 * the new bit is also added in the main/baseline.
1234 */
1235 unsigned int is_attach_supported : 1;
1236 unsigned int : 31;
1237 unsigned int : 32;
1238 unsigned int : 32;
1239 } jvm_version_info;
1240
1241 #define JVM_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1242 #define JVM_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1243 #define JVM_VERSION_SECURITY(version) ((version & 0x0000FF00) >> 8)
1244 #define JVM_VERSION_BUILD(version) ((version & 0x000000FF))
1245
1246 JNIEXPORT void JNICALL
1247 JVM_GetVersionInfo(JNIEnv* env, jvm_version_info* info, size_t info_size);
1248
1249 typedef struct {
1250 unsigned int jdk_version; /* Encoded $VNUM as specified by JEP-223 */
1251 unsigned int patch_version : 8; /* JEP-223 patch version */
1252 unsigned int reserved3 : 8;
1253 unsigned int reserved1 : 16;
1254 unsigned int reserved2;
1255 unsigned int : 32;
1256 unsigned int : 32;
1257 unsigned int : 32;
1258 } jdk_version_info;
1259
1260 #define JDK_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1261 #define JDK_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1262 #define JDK_VERSION_SECURITY(version) ((version & 0x0000FF00) >> 8)
1263 #define JDK_VERSION_BUILD(version) ((version & 0x000000FF))
1264
1265 /*
1266 * This is the function JDK_GetVersionInfo0 defined in libjava.so
1267 * that is dynamically looked up by JVM.
1268 */
1269 typedef void (*jdk_version_info_fn_t)(jdk_version_info* info, size_t info_size);
1270
1271 /*
1272 * This structure is used by the launcher to get the default thread
1273 * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1274 * version of 1.1. As it is not supported otherwise, it has been removed
1275 * from jni.h
1276 */
1277 typedef struct JDK1_1InitArgs {
1278 jint version;
1279
1280 char **properties;
1281 jint checkSource;
1282 jint nativeStackSize;
1283 jint javaStackSize;
1284 jint minHeapSize;
1285 jint maxHeapSize;
1286 jint verifyMode;
1287 char *classpath;
1288
1289 jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1290 void (JNICALL *exit)(jint code);
1291 void (JNICALL *abort)(void);
1292
1293 jint enableClassGC;
1294 jint enableVerboseGC;
1295 jint disableAsyncGC;
1296 jint verbose;
1297 jboolean debugging;
1298 jint debugPort;
1299 } JDK1_1InitArgs;
1300
1301
1302 #ifdef __cplusplus
1303 } /* extern "C" */
1304
1305 #endif /* __cplusplus */
1306
1307 #endif /* !_JAVASOFT_JVM_H_ */