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: array of packages in the module
403 */
404 JNIEXPORT void JNICALL
405 JVM_DefineModule(JNIEnv *env, jobject module, jboolean is_open, jstring version,
406 jstring location, jobjectArray packages);
407
408 /*
409 * Set the boot loader's unnamed module.
410 * module: boot loader's unnamed module
411 */
412 JNIEXPORT void JNICALL
413 JVM_SetBootLoaderUnnamedModule(JNIEnv *env, jobject module);
414
415 /*
416 * Do a qualified export of a package.
417 * from_module: module containing the package to export
418 * package: name of the package to export
419 * to_module: module to export the package to
420 */
421 JNIEXPORT void JNICALL
422 JVM_AddModuleExports(JNIEnv *env, jobject from_module, jstring package, jobject to_module);
423
424 /*
425 * Do an export of a package to all unnamed modules.
426 * from_module: module containing the package to export
427 * package: name of the package to export to all unnamed modules
428 */
429 JNIEXPORT void JNICALL
430 JVM_AddModuleExportsToAllUnnamed(JNIEnv *env, jobject from_module, jstring package);
431
432 /*
433 * Do an unqualified export of a package.
434 * from_module: module containing the package to export
435 * package: name of the package to export
436 */
437 JNIEXPORT void JNICALL
438 JVM_AddModuleExportsToAll(JNIEnv *env, jobject from_module, jstring package);
439
440 /*
441 * Add a module to the list of modules that a given module can read.
442 * from_module: module requesting read access
443 * source_module: module that from_module wants to read
444 */
445 JNIEXPORT void JNICALL
446 JVM_AddReadsModule(JNIEnv *env, jobject from_module, jobject source_module);
447
448 /*
449 * Reflection support functions
450 */
451
452 JNIEXPORT jstring JNICALL
453 JVM_InitClassName(JNIEnv *env, jclass cls);
454
455 JNIEXPORT jobjectArray JNICALL
456 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
457
458 JNIEXPORT jboolean JNICALL
459 JVM_IsInterface(JNIEnv *env, jclass cls);
460
461 JNIEXPORT jobjectArray JNICALL
462 JVM_GetClassSigners(JNIEnv *env, jclass cls);
463
464 JNIEXPORT void JNICALL
465 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
466
467 JNIEXPORT jobject JNICALL
468 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
469
470 JNIEXPORT jboolean JNICALL
471 JVM_IsArrayClass(JNIEnv *env, jclass cls);
472
473 JNIEXPORT jboolean JNICALL
474 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
475
476 JNIEXPORT jint JNICALL
477 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
478
479 JNIEXPORT jobjectArray JNICALL
480 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
481
482 JNIEXPORT jclass JNICALL
483 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
484
485 JNIEXPORT jstring JNICALL
486 JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);
487
488 /* Generics support (JDK 1.5) */
489 JNIEXPORT jstring JNICALL
490 JVM_GetClassSignature(JNIEnv *env, jclass cls);
491
492 /* Annotations support (JDK 1.5) */
493 JNIEXPORT jbyteArray JNICALL
494 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
495
496 /* Type use annotations support (JDK 1.8) */
497
498 JNIEXPORT jbyteArray JNICALL
499 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
500
501 JNIEXPORT jbyteArray JNICALL
502 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
503
504 JNIEXPORT jbyteArray JNICALL
505 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
506
507 /*
508 * New (JDK 1.4) reflection implementation
509 */
510
511 JNIEXPORT jobjectArray JNICALL
512 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
513
514 JNIEXPORT jobjectArray JNICALL
515 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
516
517 JNIEXPORT jobjectArray JNICALL
518 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
519
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 /* Records - since JDK 14 */
542
543 JNIEXPORT jboolean JNICALL
544 JVM_IsRecord(JNIEnv *env, jclass cls);
545
546 JNIEXPORT jobjectArray JNICALL
547 JVM_GetRecordComponents(JNIEnv *env, jclass ofClass);
548
549 /* The following two reflection routines are still needed due to startup time issues */
550 /*
551 * java.lang.reflect.Method
552 */
553 JNIEXPORT jobject JNICALL
554 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
555
556 /*
557 * java.lang.reflect.Constructor
558 */
559 JNIEXPORT jobject JNICALL
560 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
561
562 /*
563 * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
564 */
565
566 JNIEXPORT jobject JNICALL
567 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
568
569 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
570 (JNIEnv *env, jobject unused, jobject jcpool);
571
572 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
573 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
574
575 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
576 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
577
578 JNIEXPORT jint JNICALL JVM_ConstantPoolGetClassRefIndexAt
579 (JNIEnv *env, jobject obj, jobject unused, jint index);
580
581 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
582 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
583
584 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
585 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
586
587 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
588 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
589
590 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
591 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
592
593 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
594 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
595
596 JNIEXPORT jint JNICALL JVM_ConstantPoolGetNameAndTypeRefIndexAt
597 (JNIEnv *env, jobject obj, jobject unused, jint index);
598
599 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetNameAndTypeRefInfoAt
600 (JNIEnv *env, jobject obj, jobject unused, jint index);
601
602 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
603 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
604
605 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
606 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
607
608 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
609 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
610
611 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
612 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
613
614 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
615 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
616
617 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
618 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
619
620 JNIEXPORT jbyte JNICALL JVM_ConstantPoolGetTagAt
621 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
622
623 /*
624 * Parameter reflection
625 */
626
627 JNIEXPORT jobjectArray JNICALL
628 JVM_GetMethodParameters(JNIEnv *env, jobject method);
629
630 /*
631 * java.security.*
632 */
633
634 JNIEXPORT jobject JNICALL
635 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
636
637 /*
638 * Ensure that code doing a stackwalk and using javaVFrame::locals() to
639 * get the value will see a materialized value and not a scalar-replaced
640 * null value.
641 */
642 #define JVM_EnsureMaterializedForStackWalk(env, value) \
643 do {} while(0) // Nothing to do. The fact that the value escaped
644 // through a native method is enough.
645
646 JNIEXPORT jobject JNICALL
647 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
648
649 /*
650 * Signal support, used to implement the shutdown sequence. Every VM must
651 * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
652 * (^C) and the latter for external termination (kill, system shutdown, etc.).
653 * Other platform-dependent signal values may also be supported.
654 */
655
656 JNIEXPORT void * JNICALL
657 JVM_RegisterSignal(jint sig, void *handler);
658
659 JNIEXPORT jboolean JNICALL
660 JVM_RaiseSignal(jint sig);
661
662 JNIEXPORT jint JNICALL
663 JVM_FindSignal(const char *name);
664
665 /*
666 * Retrieve the assertion directives for the specified class.
667 */
668 JNIEXPORT jboolean JNICALL
669 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
670
671 /*
672 * Retrieve the assertion directives from the VM.
673 */
674 JNIEXPORT jobject JNICALL
675 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
676
677 /*
678 * java.util.concurrent.atomic.AtomicLong
679 */
680 JNIEXPORT jboolean JNICALL
681 JVM_SupportsCX8(void);
682
683 /*
684 * com.sun.dtrace.jsdt support
685 */
686
687 #define JVM_TRACING_DTRACE_VERSION 1
688
689 /*
690 * Structure to pass one probe description to JVM
691 */
692 typedef struct {
693 jmethodID method;
694 jstring function;
695 jstring name;
696 void* reserved[4]; // for future use
697 } JVM_DTraceProbe;
698
699 /**
700 * Encapsulates the stability ratings for a DTrace provider field
701 */
702 typedef struct {
703 jint nameStability;
704 jint dataStability;
705 jint dependencyClass;
706 } JVM_DTraceInterfaceAttributes;
707
708 /*
709 * Structure to pass one provider description to JVM
710 */
711 typedef struct {
712 jstring name;
713 JVM_DTraceProbe* probes;
714 jint probe_count;
715 JVM_DTraceInterfaceAttributes providerAttributes;
716 JVM_DTraceInterfaceAttributes moduleAttributes;
717 JVM_DTraceInterfaceAttributes functionAttributes;
718 JVM_DTraceInterfaceAttributes nameAttributes;
719 JVM_DTraceInterfaceAttributes argsAttributes;
720 void* reserved[4]; // for future use
721 } JVM_DTraceProvider;
722
723 /*
724 * Get the version number the JVM was built with
725 */
726 JNIEXPORT jint JNICALL
727 JVM_DTraceGetVersion(JNIEnv* env);
728
729 /*
730 * Register new probe with given signature, return global handle
731 *
732 * The version passed in is the version that the library code was
733 * built with.
734 */
735 JNIEXPORT jlong JNICALL
736 JVM_DTraceActivate(JNIEnv* env, jint version, jstring module_name,
737 jint providers_count, JVM_DTraceProvider* providers);
738
739 /*
740 * Check JSDT probe
741 */
742 JNIEXPORT jboolean JNICALL
743 JVM_DTraceIsProbeEnabled(JNIEnv* env, jmethodID method);
744
745 /*
746 * Destroy custom DOF
747 */
748 JNIEXPORT void JNICALL
749 JVM_DTraceDispose(JNIEnv* env, jlong activation_handle);
750
751 /*
752 * Check to see if DTrace is supported by OS
753 */
754 JNIEXPORT jboolean JNICALL
755 JVM_DTraceIsSupported(JNIEnv* env);
756
757 /*************************************************************************
758 PART 2: Support for the Verifier and Class File Format Checker
759 ************************************************************************/
760 /*
761 * Return the class name in UTF format. The result is valid
762 * until JVM_ReleaseUTf is called.
763 *
764 * The caller must treat the string as a constant and not modify it
765 * in any way.
766 */
767 JNIEXPORT const char * JNICALL
768 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
769
770 /*
771 * Returns the constant pool types in the buffer provided by "types."
772 */
773 JNIEXPORT void JNICALL
774 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
775
776 /*
777 * Returns the number of Constant Pool entries.
778 */
779 JNIEXPORT jint JNICALL
780 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
781
782 /*
783 * Returns the number of *declared* fields or methods.
784 */
785 JNIEXPORT jint JNICALL
786 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
787
788 JNIEXPORT jint JNICALL
789 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
790
791 /*
792 * Returns the CP indexes of exceptions raised by a given method.
793 * Places the result in the given buffer.
794 *
795 * The method is identified by method_index.
796 */
797 JNIEXPORT void JNICALL
798 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
799 unsigned short *exceptions);
800 /*
801 * Returns the number of exceptions raised by a given method.
802 * The method is identified by method_index.
803 */
804 JNIEXPORT jint JNICALL
805 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
806
807 /*
808 * Returns the byte code sequence of a given method.
809 * Places the result in the given buffer.
810 *
811 * The method is identified by method_index.
812 */
813 JNIEXPORT void JNICALL
814 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
815 unsigned char *code);
816
817 /*
818 * Returns the length of the byte code sequence of a given method.
819 * The method is identified by method_index.
820 */
821 JNIEXPORT jint JNICALL
822 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
823
824 /*
825 * A structure used to a capture exception table entry in a Java method.
826 */
827 typedef struct {
828 jint start_pc;
829 jint end_pc;
830 jint handler_pc;
831 jint catchType;
832 } JVM_ExceptionTableEntryType;
833
834 /*
835 * Returns the exception table entry at entry_index of a given method.
836 * Places the result in the given buffer.
837 *
838 * The method is identified by method_index.
839 */
840 JNIEXPORT void JNICALL
841 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
842 jint entry_index,
843 JVM_ExceptionTableEntryType *entry);
844
845 /*
846 * Returns the length of the exception table of a given method.
847 * The method is identified by method_index.
848 */
849 JNIEXPORT jint JNICALL
850 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
851
852 /*
853 * Returns the modifiers of a given field.
854 * The field is identified by field_index.
855 */
856 JNIEXPORT jint JNICALL
857 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
858
859 /*
860 * Returns the modifiers of a given method.
861 * The method is identified by method_index.
862 */
863 JNIEXPORT jint JNICALL
864 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
865
866 /*
867 * Returns the number of local variables of a given method.
868 * The method is identified by method_index.
869 */
870 JNIEXPORT jint JNICALL
871 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
872
873 /*
874 * Returns the number of arguments (including this pointer) of a given method.
875 * The method is identified by method_index.
876 */
877 JNIEXPORT jint JNICALL
878 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
879
880 /*
881 * Returns the maximum amount of stack (in words) used by a given method.
882 * The method is identified by method_index.
883 */
884 JNIEXPORT jint JNICALL
885 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
886
887 /*
888 * Is a given method a constructor.
889 * The method is identified by method_index.
890 */
891 JNIEXPORT jboolean JNICALL
892 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
893
894 /*
895 * Is the given method generated by the VM.
896 * The method is identified by method_index.
897 */
898 JNIEXPORT jboolean JNICALL
899 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
900
901 /*
902 * Returns the name of a given method in UTF format.
903 * The result remains valid until JVM_ReleaseUTF is called.
904 *
905 * The caller must treat the string as a constant and not modify it
906 * in any way.
907 */
908 JNIEXPORT const char * JNICALL
909 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
910
911 /*
912 * Returns the signature of a given method in UTF format.
913 * The result remains valid until JVM_ReleaseUTF is called.
914 *
915 * The caller must treat the string as a constant and not modify it
916 * in any way.
917 */
918 JNIEXPORT const char * JNICALL
919 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
920
921 /*
922 * Returns the name of the field referred to at a given constant pool
923 * index.
924 *
925 * The result is in UTF format and remains valid until JVM_ReleaseUTF
926 * is called.
927 *
928 * The caller must treat the string as a constant and not modify it
929 * in any way.
930 */
931 JNIEXPORT const char * JNICALL
932 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
933
934 /*
935 * Returns the name of the method referred to at a given constant pool
936 * index.
937 *
938 * The result is in UTF format and remains valid until JVM_ReleaseUTF
939 * is called.
940 *
941 * The caller must treat the string as a constant and not modify it
942 * in any way.
943 */
944 JNIEXPORT const char * JNICALL
945 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
946
947 /*
948 * Returns the signature of the method referred to at a given constant pool
949 * index.
950 *
951 * The result is in UTF format and remains valid until JVM_ReleaseUTF
952 * is called.
953 *
954 * The caller must treat the string as a constant and not modify it
955 * in any way.
956 */
957 JNIEXPORT const char * JNICALL
958 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
959
960 /*
961 * Returns the signature of the field referred to at a given constant pool
962 * index.
963 *
964 * The result is in UTF format and remains valid until JVM_ReleaseUTF
965 * is called.
966 *
967 * The caller must treat the string as a constant and not modify it
968 * in any way.
969 */
970 JNIEXPORT const char * JNICALL
971 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
972
973 /*
974 * Returns the class name referred to at a given constant pool index.
975 *
976 * The result is in UTF format and remains valid until JVM_ReleaseUTF
977 * is called.
978 *
979 * The caller must treat the string as a constant and not modify it
980 * in any way.
981 */
982 JNIEXPORT const char * JNICALL
983 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
984
985 /*
986 * Returns the class name referred to at a given constant pool index.
987 *
988 * The constant pool entry must refer to a CONSTANT_Fieldref.
989 *
990 * The result is in UTF format and remains valid until JVM_ReleaseUTF
991 * is called.
992 *
993 * The caller must treat the string as a constant and not modify it
994 * in any way.
995 */
996 JNIEXPORT const char * JNICALL
997 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
998
999 /*
1000 * Returns the class name referred to at a given constant pool index.
1001 *
1002 * The constant pool entry must refer to CONSTANT_Methodref or
1003 * CONSTANT_InterfaceMethodref.
1004 *
1005 * The result is in UTF format and remains valid until JVM_ReleaseUTF
1006 * is called.
1007 *
1008 * The caller must treat the string as a constant and not modify it
1009 * in any way.
1010 */
1011 JNIEXPORT const char * JNICALL
1012 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
1013
1014 /*
1015 * Returns the modifiers of a field in calledClass. The field is
1016 * referred to in class cb at constant pool entry index.
1017 *
1018 * The caller must treat the string as a constant and not modify it
1019 * in any way.
1020 *
1021 * Returns -1 if the field does not exist in calledClass.
1022 */
1023 JNIEXPORT jint JNICALL
1024 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1025
1026 /*
1027 * Returns the modifiers of a method in calledClass. The method is
1028 * referred to in class cb at constant pool entry index.
1029 *
1030 * Returns -1 if the method does not exist in calledClass.
1031 */
1032 JNIEXPORT jint JNICALL
1033 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1034
1035 /*
1036 * Releases the UTF string obtained from the VM.
1037 */
1038 JNIEXPORT void JNICALL
1039 JVM_ReleaseUTF(const char *utf);
1040
1041 /*
1042 * Compare if two classes are in the same package.
1043 */
1044 JNIEXPORT jboolean JNICALL
1045 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
1046
1047 /* Get classfile constants */
1048 #include "classfile_constants.h"
1049
1050 /*
1051 * Support for a VM-independent class format checker.
1052 */
1053 typedef struct {
1054 unsigned long code; /* byte code */
1055 unsigned long excs; /* exceptions */
1056 unsigned long etab; /* catch table */
1057 unsigned long lnum; /* line number */
1058 unsigned long lvar; /* local vars */
1059 } method_size_info;
1060
1061 typedef struct {
1062 unsigned int constants; /* constant pool */
1063 unsigned int fields;
1064 unsigned int methods;
1065 unsigned int interfaces;
1066 unsigned int fields2; /* number of static 2-word fields */
1067 unsigned int innerclasses; /* # of records in InnerClasses attr */
1068
1069 method_size_info clinit; /* memory used in clinit */
1070 method_size_info main; /* used everywhere else */
1071 } class_size_info;
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 /*************************************************************************
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 * This structure is used by the launcher to get the default thread
1190 * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1191 * version of 1.1. As it is not supported otherwise, it has been removed
1192 * from jni.h
1193 */
1194 typedef struct JDK1_1InitArgs {
1195 jint version;
1196
1197 char **properties;
1198 jint checkSource;
1199 jint nativeStackSize;
1200 jint javaStackSize;
1201 jint minHeapSize;
1202 jint maxHeapSize;
1203 jint verifyMode;
1204 char *classpath;
1205
1206 jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1207 void (JNICALL *exit)(jint code);
1208 void (JNICALL *abort)(void);
1209
1210 jint enableClassGC;
1211 jint enableVerboseGC;
1212 jint disableAsyncGC;
1213 jint verbose;
1214 jboolean debugging;
1215 jint debugPort;
1216 } JDK1_1InitArgs;
1217
1218
1219 #ifdef __cplusplus
1220 } /* extern "C" */
1221
1222 #endif /* __cplusplus */
1223
1224 #endif /* !_JAVASOFT_JVM_H_ */