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