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