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