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