1 /*
2 * Copyright (c) 1997, 2025, 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_constants.h"
33 #include "jvm_io.h"
34 #include "jvm_md.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /*
41 * This file contains additional functions exported from the VM.
42 * These functions are complementary to the standard JNI support.
43 * There are three parts to this file:
44 *
45 * First, this file contains the VM-related functions needed by native
46 * libraries in the standard Java API. For example, the java.lang.Object
47 * class needs VM-level functions that wait for and notify monitors.
48 *
49 * Second, (included from jvm_constants.h) constant definitions
50 * needed by the byte code verifier and class file format checker.
51 * These definitions allow the verifier and format checker to be written
52 * in a VM-independent way.
53 *
54 * Third, this file contains various I/O and network operations needed
55 * by the standard Java I/O and network APIs. A part of these APIs,
56 * namely the jio_xxxprintf functions, are included from jvm_io.h.
57 */
58
59
60 /*************************************************************************
61 PART 1: Functions for Native Libraries
62 ************************************************************************/
63 /*
64 * java.lang.Object
65 */
66 JNIEXPORT jint JNICALL
67 JVM_IHashCode(JNIEnv *env, jobject obj);
68
69 JNIEXPORT void JNICALL
70 JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);
71
72 JNIEXPORT void JNICALL
73 JVM_MonitorNotify(JNIEnv *env, jobject obj);
74
75 JNIEXPORT void JNICALL
76 JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);
77
78 JNIEXPORT jobject JNICALL
79 JVM_Clone(JNIEnv *env, jobject obj);
80
81 /*
82 * java.lang.String
83 */
84 JNIEXPORT jstring JNICALL
85 JVM_InternString(JNIEnv *env, jstring str);
86
87 /*
88 * java.lang.System
89 */
90 JNIEXPORT jlong JNICALL
91 JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);
92
93 JNIEXPORT jlong JNICALL
94 JVM_NanoTime(JNIEnv *env, jclass ignored);
95
96 JNIEXPORT jlong JNICALL
97 JVM_GetNanoTimeAdjustment(JNIEnv *env, jclass ignored, jlong offset_secs);
98
99 JNIEXPORT void JNICALL
100 JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,
101 jobject dst, jint dst_pos, jint length);
102
103 /*
104 * Return an array of all properties as alternating name and value pairs.
105 */
106 JNIEXPORT jobjectArray JNICALL
107 JVM_GetProperties(JNIEnv *env);
108
109 /*
110 * java.lang.Runtime
111 */
112 JNIEXPORT void JNICALL
113 JVM_BeforeHalt();
114
115 JNIEXPORT void JNICALL
116 JVM_Halt(jint code);
117
118 JNIEXPORT void JNICALL
119 JVM_GC(void);
120
121 /* Returns the number of real-time milliseconds that have elapsed since the
122 * least-recently-inspected heap object was last inspected by the garbage
123 * collector.
124 *
125 * For simple stop-the-world collectors this value is just the time
126 * since the most recent collection. For generational collectors it is the
127 * time since the oldest generation was most recently collected. Other
128 * collectors are free to return a pessimistic estimate of the elapsed time, or
129 * simply the time since the last full collection was performed.
130 *
131 * Note that in the presence of reference objects, a given object that is no
132 * longer strongly reachable may have to be inspected multiple times before it
133 * can be reclaimed.
134 */
135 JNIEXPORT jlong JNICALL
136 JVM_MaxObjectInspectionAge(void);
137
138 JNIEXPORT jlong JNICALL
139 JVM_TotalMemory(void);
140
141 JNIEXPORT jlong JNICALL
142 JVM_FreeMemory(void);
143
144 JNIEXPORT jlong JNICALL
145 JVM_MaxMemory(void);
146
147 JNIEXPORT jint JNICALL
148 JVM_ActiveProcessorCount(void);
149
150 JNIEXPORT jboolean JNICALL
151 JVM_IsUseContainerSupport(void);
152
153 JNIEXPORT jboolean JNICALL
154 JVM_IsContainerized(void);
155
156 JNIEXPORT void * JNICALL
157 JVM_LoadZipLibrary();
158
159 JNIEXPORT void * JNICALL
160 JVM_LoadLibrary(const char *name, jboolean throwException);
161
162 JNIEXPORT void JNICALL
163 JVM_UnloadLibrary(void * handle);
164
165 JNIEXPORT void * JNICALL
166 JVM_FindLibraryEntry(void *handle, const char *name);
167
168 JNIEXPORT jboolean JNICALL
169 JVM_IsSupportedJNIVersion(jint version);
170
171 JNIEXPORT jobjectArray JNICALL
172 JVM_GetVmArguments(JNIEnv *env);
173
174 JNIEXPORT jboolean JNICALL
175 JVM_IsPreviewEnabled(void);
176
177 JNIEXPORT jboolean JNICALL
178 JVM_IsContinuationsSupported(void);
179
180 JNIEXPORT jboolean JNICALL
181 JVM_IsForeignLinkerSupported(void);
182
183 JNIEXPORT jboolean JNICALL
184 JVM_IsStaticallyLinked(void);
185
186 JNIEXPORT void JNICALL
187 JVM_InitializeFromArchive(JNIEnv* env, jclass cls);
188
189 JNIEXPORT void JNICALL
190 JVM_RegisterLambdaProxyClassForArchiving(JNIEnv* env, jclass caller,
191 jstring interfaceMethodName,
192 jobject factoryType,
193 jobject interfaceMethodType,
194 jobject implementationMember,
195 jobject dynamicMethodType,
196 jclass lambdaProxyClass);
197
198 JNIEXPORT jclass JNICALL
199 JVM_LookupLambdaProxyClassFromArchive(JNIEnv* env, jclass caller,
200 jstring interfaceMethodName,
201 jobject factoryType,
202 jobject interfaceMethodType,
203 jobject implementationMember,
204 jobject dynamicMethodType);
205
206 JNIEXPORT jint JNICALL
207 JVM_GetCDSConfigStatus();
208
209 JNIEXPORT jlong JNICALL
210 JVM_GetRandomSeedForDumping();
211
212 JNIEXPORT void JNICALL
213 JVM_LogLambdaFormInvoker(JNIEnv* env, jstring line);
214
215 JNIEXPORT void JNICALL
216 JVM_DumpClassListToFile(JNIEnv* env, jstring fileName);
217
218 JNIEXPORT void JNICALL
219 JVM_DumpDynamicArchive(JNIEnv* env, jstring archiveName);
220
221 JNIEXPORT jboolean JNICALL
222 JVM_NeedsClassInitBarrierForCDS(JNIEnv* env, jclass cls);
223
224 /*
225 * java.lang.Throwable
226 */
227 JNIEXPORT void JNICALL
228 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
229
230 /*
231 * java.lang.StackTraceElement
232 */
233 JNIEXPORT void JNICALL
234 JVM_InitStackTraceElementArray(JNIEnv *env, jobjectArray elements, jobject backtrace, jint depth);
235
236 JNIEXPORT void JNICALL
237 JVM_InitStackTraceElement(JNIEnv* env, jobject element, jobject stackFrameInfo);
238
239 /*
240 * java.lang.NullPointerException
241 */
242
243 JNIEXPORT jstring JNICALL
244 JVM_GetExtendedNPEMessage(JNIEnv *env, jthrowable throwable);
245
246 /*
247 * java.lang.StackWalker
248 */
249 enum {
250 JVM_STACKWALK_CLASS_INFO_ONLY = 0x2,
251 JVM_STACKWALK_SHOW_HIDDEN_FRAMES = 0x20,
252 JVM_STACKWALK_FILL_LIVE_STACK_FRAMES = 0x100
253 };
254
255 JNIEXPORT void JNICALL
256 JVM_ExpandStackFrameInfo(JNIEnv *env, jobject obj);
257
258 JNIEXPORT jobject JNICALL
259 JVM_CallStackWalk(JNIEnv *env, jobject stackStream, jint mode,
260 jint skip_frames, jobject contScope, jobject cont,
261 jint buffer_size, jint start_index, jobjectArray frames);
262
263 JNIEXPORT jint JNICALL
264 JVM_MoreStackWalk(JNIEnv *env, jobject stackStream, jint mode, jlong anchor,
265 jint last_batch_count, jint buffer_size, jint start_index,
266 jobjectArray frames);
267
268 JNIEXPORT void JNICALL
269 JVM_SetStackWalkContinuation(JNIEnv *env, jobject stackStream, jlong anchor, jobjectArray frames, jobject cont);
270
271 /*
272 * java.lang.Thread
273 */
274 JNIEXPORT void JNICALL
275 JVM_StartThread(JNIEnv *env, jobject thread);
276
277 JNIEXPORT void JNICALL
278 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
279
280 JNIEXPORT void JNICALL
281 JVM_Yield(JNIEnv *env, jclass threadClass);
282
283 JNIEXPORT void JNICALL
284 JVM_SleepNanos(JNIEnv *env, jclass threadClass, jlong nanos);
285
286 JNIEXPORT jobject JNICALL
287 JVM_CurrentCarrierThread(JNIEnv *env, jclass threadClass);
288
289 JNIEXPORT jobject JNICALL
290 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
291
292 JNIEXPORT void JNICALL
293 JVM_SetCurrentThread(JNIEnv *env, jobject thisThread, jobject theThread);
294
295 JNIEXPORT void JNICALL
296 JVM_Interrupt(JNIEnv *env, jobject thread);
297
298 JNIEXPORT jboolean JNICALL
299 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
300
301 JNIEXPORT jobject JNICALL
302 JVM_GetStackTrace(JNIEnv *env, jobject thread);
303
304 JNIEXPORT jobject JNICALL
305 JVM_CreateThreadSnapshot(JNIEnv* env, jobject thread, jboolean withLocks);
306
307 JNIEXPORT jobjectArray JNICALL
308 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
309
310 JNIEXPORT void JNICALL
311 JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);
312
313 /* getStackTrace() and getAllStackTraces() method */
314 JNIEXPORT jobjectArray JNICALL
315 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
316
317 JNIEXPORT jobject JNICALL
318 JVM_ScopedValueCache(JNIEnv *env, jclass threadClass);
319
320 JNIEXPORT void JNICALL
321 JVM_SetScopedValueCache(JNIEnv *env, jclass threadClass, jobject theCache);
322
323 JNIEXPORT jobject JNICALL
324 JVM_FindScopedValueBindings(JNIEnv *env, jclass threadClass);
325
326 JNIEXPORT jlong JNICALL
327 JVM_GetNextThreadIdOffset(JNIEnv *env, jclass threadClass);
328
329 /*
330 * jdk.internal.vm.Continuation
331 */
332 JNIEXPORT void JNICALL
333 JVM_RegisterContinuationMethods(JNIEnv *env, jclass cls);
334
335 /*
336 * java.lang.Package
337 */
338 JNIEXPORT jstring JNICALL
339 JVM_GetSystemPackage(JNIEnv *env, jstring name);
340
341 JNIEXPORT jobjectArray JNICALL
342 JVM_GetSystemPackages(JNIEnv *env);
343
344 /*
345 * java.lang.ref.Reference
346 */
347 JNIEXPORT jobject JNICALL
348 JVM_GetAndClearReferencePendingList(JNIEnv *env);
349
350 JNIEXPORT jboolean JNICALL
351 JVM_HasReferencePendingList(JNIEnv *env);
352
353 JNIEXPORT void JNICALL
354 JVM_WaitForReferencePendingList(JNIEnv *env);
355
356 JNIEXPORT jboolean JNICALL
357 JVM_ReferenceRefersTo(JNIEnv *env, jobject ref, jobject o);
358
359 JNIEXPORT void JNICALL
360 JVM_ReferenceClear(JNIEnv *env, jobject ref);
361
362 /*
363 * java.lang.ref.PhantomReference
364 */
365 JNIEXPORT jboolean JNICALL
366 JVM_PhantomReferenceRefersTo(JNIEnv *env, jobject ref, jobject o);
367
368 /*
369 * java.io.ObjectInputStream
370 */
371 JNIEXPORT jobject JNICALL
372 JVM_LatestUserDefinedLoader(JNIEnv *env);
373
374 /*
375 * java.lang.reflect.Array
376 */
377 JNIEXPORT jint JNICALL
378 JVM_GetArrayLength(JNIEnv *env, jobject arr);
379
380 JNIEXPORT jobject JNICALL
381 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
382
383 JNIEXPORT jvalue JNICALL
384 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
385
386 JNIEXPORT void JNICALL
387 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
388
389 JNIEXPORT void JNICALL
390 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
391 unsigned char vCode);
392
393 JNIEXPORT jobject JNICALL
394 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
395
396 JNIEXPORT jobject JNICALL
397 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
398
399
400 /*
401 * Returns the immediate caller class of the native method invoking
402 * JVM_GetCallerClass. The Method.invoke and other frames due to
403 * reflection machinery are skipped.
404 *
405 * The caller is expected to be marked with
406 * jdk.internal.reflect.CallerSensitive. The JVM will throw an
407 * error if it is not marked properly.
408 */
409 JNIEXPORT jclass JNICALL
410 JVM_GetCallerClass(JNIEnv *env);
411
412
413 /*
414 * Find primitive classes
415 * utf: class name
416 */
417 JNIEXPORT jclass JNICALL
418 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
419
420
421 /*
422 * Find a class from a boot class loader. Returns null if class not found.
423 */
424 JNIEXPORT jclass JNICALL
425 JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);
426
427 /*
428 * Find a class from a given class loader. Throws ClassNotFoundException.
429 * name: name of class
430 * init: whether initialization is done
431 * loader: class loader to look up the class. This may not be the same as the caller's
432 * class loader.
433 * caller: initiating class. The initiating class may be null when a security
434 * manager is not installed.
435 */
436 JNIEXPORT jclass JNICALL
437 JVM_FindClassFromCaller(JNIEnv *env, const char *name, jboolean init,
438 jobject loader, jclass caller);
439
440 /*
441 * Find a class from a given class.
442 */
443 JNIEXPORT jclass JNICALL
444 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
445 jclass from);
446
447 /* Find a loaded class cached by the VM */
448 JNIEXPORT jclass JNICALL
449 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
450
451 /* Define a class */
452 JNIEXPORT jclass JNICALL
453 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
454 jsize len, jobject pd);
455
456 /* Define a class with a source (added in JDK1.5) */
457 JNIEXPORT jclass JNICALL
458 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
459 const jbyte *buf, jsize len, jobject pd,
460 const char *source);
461
462 /*
463 * Define a class with the specified lookup class.
464 * lookup: Lookup class
465 * name: the name of the class
466 * buf: class bytes
467 * len: length of class bytes
468 * pd: protection domain
469 * init: initialize the class
470 * flags: properties of the class
471 * classData: private static pre-initialized field; may be null
472 */
473 JNIEXPORT jclass JNICALL
474 JVM_LookupDefineClass(JNIEnv *env, jclass lookup, const char *name, const jbyte *buf,
475 jsize len, jobject pd, jboolean init, int flags, jobject classData);
476
477 /*
478 * Module support functions
479 */
480
481 /*
482 * Define a module with the specified packages and bind the module to the
483 * given class loader.
484 * module: module to define
485 * is_open: specifies if module is open (currently ignored)
486 * version: the module version
487 * location: the module location
488 * packages: array of packages in the module
489 */
490 JNIEXPORT void JNICALL
491 JVM_DefineModule(JNIEnv *env, jobject module, jboolean is_open, jstring version,
492 jstring location, jobjectArray packages);
493
494 /*
495 * Set the boot loader's unnamed module.
496 * module: boot loader's unnamed module
497 */
498 JNIEXPORT void JNICALL
499 JVM_SetBootLoaderUnnamedModule(JNIEnv *env, jobject module);
500
501 /*
502 * Do a qualified export of a package.
503 * from_module: module containing the package to export
504 * package: name of the package to export
505 * to_module: module to export the package to
506 */
507 JNIEXPORT void JNICALL
508 JVM_AddModuleExports(JNIEnv *env, jobject from_module, jstring package, jobject to_module);
509
510 /*
511 * Do an export of a package to all unnamed modules.
512 * from_module: module containing the package to export
513 * package: name of the package to export to all unnamed modules
514 */
515 JNIEXPORT void JNICALL
516 JVM_AddModuleExportsToAllUnnamed(JNIEnv *env, jobject from_module, jstring package);
517
518 /*
519 * Do an unqualified export of a package.
520 * from_module: module containing the package to export
521 * package: name of the package to export
522 */
523 JNIEXPORT void JNICALL
524 JVM_AddModuleExportsToAll(JNIEnv *env, jobject from_module, jstring package);
525
526 /*
527 * Add a module to the list of modules that a given module can read.
528 * from_module: module requesting read access
529 * source_module: module that from_module wants to read
530 */
531 JNIEXPORT void JNICALL
532 JVM_AddReadsModule(JNIEnv *env, jobject from_module, jobject source_module);
533
534 /*
535 * Define all modules that have been stored in the CDS archived heap.
536 * platform_loader: the built-in platform class loader
537 * system_loader: the built-in system class loader
538 */
539 JNIEXPORT void JNICALL
540 JVM_DefineArchivedModules(JNIEnv *env, jobject platform_loader, jobject system_loader);
541
542 /*
543 * Reflection support functions
544 */
545
546 JNIEXPORT jstring JNICALL
547 JVM_InitClassName(JNIEnv *env, jclass cls);
548
549 JNIEXPORT jobjectArray JNICALL
550 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
551
552 JNIEXPORT jboolean JNICALL
553 JVM_IsInterface(JNIEnv *env, jclass cls);
554
555 JNIEXPORT jboolean JNICALL
556 JVM_IsHiddenClass(JNIEnv *env, jclass cls);
557
558 JNIEXPORT jobjectArray JNICALL
559 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
560
561 JNIEXPORT jclass JNICALL
562 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
563
564 JNIEXPORT jstring JNICALL
565 JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);
566
567 /* Generics support (JDK 1.5) */
568 JNIEXPORT jstring JNICALL
569 JVM_GetClassSignature(JNIEnv *env, jclass cls);
570
571 /* Annotations support (JDK 1.5) */
572 JNIEXPORT jbyteArray JNICALL
573 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
574
575 /* Type use annotations support (JDK 1.8) */
576
577 JNIEXPORT jbyteArray JNICALL
578 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
579
580 JNIEXPORT jbyteArray JNICALL
581 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
582
583 JNIEXPORT jbyteArray JNICALL
584 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
585
586 /*
587 * New (JDK 1.4) reflection implementation
588 */
589
590 JNIEXPORT jobjectArray JNICALL
591 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
592
593 JNIEXPORT jobjectArray JNICALL
594 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
595
596 JNIEXPORT jobjectArray JNICALL
597 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
598
599
600 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
601 This returns the access flags for the class as specified in the
602 class file rather than searching the InnerClasses attribute (if
603 present) to find the source-level access flags. Only the values of
604 the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
605 valid. */
606 JNIEXPORT jint JNICALL
607 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
608
609 /* Nestmates - since JDK 11 */
610
611 JNIEXPORT jboolean JNICALL
612 JVM_AreNestMates(JNIEnv *env, jclass current, jclass member);
613
614 JNIEXPORT jclass JNICALL
615 JVM_GetNestHost(JNIEnv *env, jclass current);
616
617 JNIEXPORT jobjectArray JNICALL
618 JVM_GetNestMembers(JNIEnv *env, jclass current);
619
620 /* Records - since JDK 16 */
621
622 JNIEXPORT jboolean JNICALL
623 JVM_IsRecord(JNIEnv *env, jclass cls);
624
625 JNIEXPORT jobjectArray JNICALL
626 JVM_GetRecordComponents(JNIEnv *env, jclass ofClass);
627
628 /* Sealed classes - since JDK 17 */
629
630 JNIEXPORT jobjectArray JNICALL
631 JVM_GetPermittedSubclasses(JNIEnv *env, jclass current);
632
633 /* The following two reflection routines are still needed due to startup time issues */
634 /*
635 * java.lang.reflect.Method
636 */
637 JNIEXPORT jobject JNICALL
638 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
639
640 /*
641 * java.lang.reflect.Constructor
642 */
643 JNIEXPORT jobject JNICALL
644 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
645
646 /*
647 * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
648 */
649
650 JNIEXPORT jobject JNICALL
651 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
652
653 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
654 (JNIEnv *env, jobject unused, jobject jcpool);
655
656 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
657 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
658
659 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
660 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
661
662 JNIEXPORT jint JNICALL JVM_ConstantPoolGetClassRefIndexAt
663 (JNIEnv *env, jobject obj, jobject unused, jint index);
664
665 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
666 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
667
668 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
669 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
670
671 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
672 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
673
674 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
675 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
676
677 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
678 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
679
680 JNIEXPORT jint JNICALL JVM_ConstantPoolGetNameAndTypeRefIndexAt
681 (JNIEnv *env, jobject obj, jobject unused, jint index);
682
683 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetNameAndTypeRefInfoAt
684 (JNIEnv *env, jobject obj, jobject unused, jint index);
685
686 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
687 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
688
689 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
690 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
691
692 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
693 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
694
695 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
696 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
697
698 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
699 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
700
701 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
702 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
703
704 JNIEXPORT jbyte JNICALL JVM_ConstantPoolGetTagAt
705 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
706
707 /*
708 * Parameter reflection
709 */
710
711 JNIEXPORT jobjectArray JNICALL
712 JVM_GetMethodParameters(JNIEnv *env, jobject method);
713
714 /*
715 * Ensure that code doing a stackwalk and using javaVFrame::locals() to
716 * get the value will see a materialized value and not a scalar-replaced
717 * null value.
718 */
719 #define JVM_EnsureMaterializedForStackWalk(env, value) \
720 do {} while(0) // Nothing to do. The fact that the value escaped
721 // through a native method is enough.
722 JNIEXPORT void JNICALL
723 JVM_EnsureMaterializedForStackWalk_func(JNIEnv* env, jobject vthread, jobject value);
724
725 /*
726 * Signal support, used to implement the shutdown sequence. Every VM must
727 * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
728 * (^C) and the latter for external termination (kill, system shutdown, etc.).
729 * Other platform-dependent signal values may also be supported.
730 */
731
732 JNIEXPORT void * JNICALL
733 JVM_RegisterSignal(jint sig, void *handler);
734
735 JNIEXPORT jboolean JNICALL
736 JVM_RaiseSignal(jint sig);
737
738 JNIEXPORT jint JNICALL
739 JVM_FindSignal(const char *name);
740
741 /*
742 * Retrieve the assertion directives for the specified class.
743 */
744 JNIEXPORT jboolean JNICALL
745 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
746
747 /*
748 * Retrieve the assertion directives from the VM.
749 */
750 JNIEXPORT jobject JNICALL
751 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
752
753 /*
754 * java.lang.ref.Finalizer
755 */
756 JNIEXPORT void JNICALL
757 JVM_ReportFinalizationComplete(JNIEnv *env, jobject finalizee);
758
759 JNIEXPORT jboolean JNICALL
760 JVM_IsFinalizationEnabled(JNIEnv *env);
761
762 /*************************************************************************
763 PART 2: Support for the Verifier and Class File Format Checker
764 ************************************************************************/
765 /*
766 * Return the class name in UTF format. The result is valid
767 * until JVM_ReleaseUTf is called.
768 *
769 * The caller must treat the string as a constant and not modify it
770 * in any way.
771 */
772 JNIEXPORT const char * JNICALL
773 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
774
775 /*
776 * Returns the constant pool types in the buffer provided by "types."
777 */
778 JNIEXPORT void JNICALL
779 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
780
781 /*
782 * Returns the number of Constant Pool entries.
783 */
784 JNIEXPORT jint JNICALL
785 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
786
787 /*
788 * Returns the number of *declared* fields or methods.
789 */
790 JNIEXPORT jint JNICALL
791 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
792
793 JNIEXPORT jint JNICALL
794 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
795
796 /*
797 * Returns the CP indexes of exceptions raised by a given method.
798 * Places the result in the given buffer.
799 *
800 * The method is identified by method_index.
801 */
802 JNIEXPORT void JNICALL
803 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
804 unsigned short *exceptions);
805 /*
806 * Returns the number of exceptions raised by a given method.
807 * The method is identified by method_index.
808 */
809 JNIEXPORT jint JNICALL
810 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
811
812 /*
813 * Returns the byte code sequence of a given method.
814 * Places the result in the given buffer.
815 *
816 * The method is identified by method_index.
817 */
818 JNIEXPORT void JNICALL
819 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
820 unsigned char *code);
821
822 /*
823 * Returns the length of the byte code sequence of a given method.
824 * The method is identified by method_index.
825 */
826 JNIEXPORT jint JNICALL
827 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
828
829 /*
830 * A structure used to a capture exception table entry in a Java method.
831 */
832 typedef struct {
833 jint start_pc;
834 jint end_pc;
835 jint handler_pc;
836 jint catchType;
837 } JVM_ExceptionTableEntryType;
838
839 /*
840 * Returns the exception table entry at entry_index of a given method.
841 * Places the result in the given buffer.
842 *
843 * The method is identified by method_index.
844 */
845 JNIEXPORT void JNICALL
846 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
847 jint entry_index,
848 JVM_ExceptionTableEntryType *entry);
849
850 /*
851 * Returns the length of the exception table of a given method.
852 * The method is identified by method_index.
853 */
854 JNIEXPORT jint JNICALL
855 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
856
857 /*
858 * Returns the modifiers of a given field.
859 * The field is identified by field_index.
860 */
861 JNIEXPORT jint JNICALL
862 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
863
864 /*
865 * Returns the modifiers of a given method.
866 * The method is identified by method_index.
867 */
868 JNIEXPORT jint JNICALL
869 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
870
871 /*
872 * Returns the number of local variables of a given method.
873 * The method is identified by method_index.
874 */
875 JNIEXPORT jint JNICALL
876 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
877
878 /*
879 * Returns the number of arguments (including this pointer) of a given method.
880 * The method is identified by method_index.
881 */
882 JNIEXPORT jint JNICALL
883 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
884
885 /*
886 * Returns the maximum amount of stack (in words) used by a given method.
887 * The method is identified by method_index.
888 */
889 JNIEXPORT jint JNICALL
890 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
891
892 /*
893 * Is a given method a constructor.
894 * The method is identified by method_index.
895 */
896 JNIEXPORT jboolean JNICALL
897 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
898
899 /*
900 * Is the given method generated by the VM.
901 * The method is identified by method_index.
902 */
903 JNIEXPORT jboolean JNICALL
904 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
905
906 /*
907 * Returns the name of a given method in UTF format.
908 * The result remains valid until JVM_ReleaseUTF is called.
909 *
910 * The caller must treat the string as a constant and not modify it
911 * in any way.
912 */
913 JNIEXPORT const char * JNICALL
914 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
915
916 /*
917 * Returns the signature of a given method in UTF format.
918 * The result remains valid until JVM_ReleaseUTF is called.
919 *
920 * The caller must treat the string as a constant and not modify it
921 * in any way.
922 */
923 JNIEXPORT const char * JNICALL
924 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
925
926 /*
927 * Returns the name of the field referred to at a given constant pool
928 * index.
929 *
930 * The result is in UTF format and remains valid until JVM_ReleaseUTF
931 * is called.
932 *
933 * The caller must treat the string as a constant and not modify it
934 * in any way.
935 */
936 JNIEXPORT const char * JNICALL
937 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
938
939 /*
940 * Returns the name of the method referred to at a given constant pool
941 * index.
942 *
943 * The result is in UTF format and remains valid until JVM_ReleaseUTF
944 * is called.
945 *
946 * The caller must treat the string as a constant and not modify it
947 * in any way.
948 */
949 JNIEXPORT const char * JNICALL
950 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
951
952 /*
953 * Returns the signature of the method referred to at a given constant pool
954 * index.
955 *
956 * The result is in UTF format and remains valid until JVM_ReleaseUTF
957 * is called.
958 *
959 * The caller must treat the string as a constant and not modify it
960 * in any way.
961 */
962 JNIEXPORT const char * JNICALL
963 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
964
965 /*
966 * Returns the signature of the field referred to at a given constant pool
967 * 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_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
977
978 /*
979 * Returns the class name referred to at a given constant pool index.
980 *
981 * The result is in UTF format and remains valid until JVM_ReleaseUTF
982 * is called.
983 *
984 * The caller must treat the string as a constant and not modify it
985 * in any way.
986 */
987 JNIEXPORT const char * JNICALL
988 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
989
990 /*
991 * Returns the class name referred to at a given constant pool index.
992 *
993 * The constant pool entry must refer to a CONSTANT_Fieldref.
994 *
995 * The result is in UTF format and remains valid until JVM_ReleaseUTF
996 * is called.
997 *
998 * The caller must treat the string as a constant and not modify it
999 * in any way.
1000 */
1001 JNIEXPORT const char * JNICALL
1002 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
1003
1004 /*
1005 * Returns the class name referred to at a given constant pool index.
1006 *
1007 * The constant pool entry must refer to CONSTANT_Methodref or
1008 * CONSTANT_InterfaceMethodref.
1009 *
1010 * The result is in UTF format and remains valid until JVM_ReleaseUTF
1011 * is called.
1012 *
1013 * The caller must treat the string as a constant and not modify it
1014 * in any way.
1015 */
1016 JNIEXPORT const char * JNICALL
1017 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
1018
1019 /*
1020 * Returns the modifiers of a field in calledClass. The field is
1021 * referred to in class cb at constant pool entry index.
1022 *
1023 * The caller must treat the string as a constant and not modify it
1024 * in any way.
1025 *
1026 * Returns -1 if the field does not exist in calledClass.
1027 */
1028 JNIEXPORT jint JNICALL
1029 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1030
1031 /*
1032 * Returns the modifiers of a method in calledClass. The method is
1033 * referred to in class cb at constant pool entry index.
1034 *
1035 * Returns -1 if the method does not exist in calledClass.
1036 */
1037 JNIEXPORT jint JNICALL
1038 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1039
1040 /*
1041 * Releases the UTF string obtained from the VM.
1042 */
1043 JNIEXPORT void JNICALL
1044 JVM_ReleaseUTF(const char *utf);
1045
1046 /*
1047 * Compare if two classes are in the same package.
1048 */
1049 JNIEXPORT jboolean JNICALL
1050 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
1051
1052
1053 /*************************************************************************
1054 PART 3: I/O and Network Support
1055 ************************************************************************/
1056
1057 /*
1058 * Convert a pathname into native format. This function does syntactic
1059 * cleanup, such as removing redundant separator characters. It modifies
1060 * the given pathname string in place.
1061 */
1062 JNIEXPORT char * JNICALL
1063 JVM_NativePath(char *);
1064
1065 JNIEXPORT void * JNICALL
1066 JVM_RawMonitorCreate(void);
1067
1068 JNIEXPORT void JNICALL
1069 JVM_RawMonitorDestroy(void *mon);
1070
1071 JNIEXPORT jint JNICALL
1072 JVM_RawMonitorEnter(void *mon);
1073
1074 JNIEXPORT void JNICALL
1075 JVM_RawMonitorExit(void *mon);
1076
1077 /*
1078 * java.lang.management support
1079 */
1080 JNIEXPORT void* JNICALL
1081 JVM_GetManagement(jint version);
1082
1083 /*
1084 * com.sun.tools.attach.VirtualMachine support
1085 *
1086 * Initialize the agent properties with the properties maintained in the VM.
1087 */
1088 JNIEXPORT jobject JNICALL
1089 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
1090
1091 JNIEXPORT jstring JNICALL
1092 JVM_GetTemporaryDirectory(JNIEnv *env);
1093
1094 /* Generics reflection support.
1095 *
1096 * Returns information about the given class's EnclosingMethod
1097 * attribute, if present, or null if the class had no enclosing
1098 * method.
1099 *
1100 * If non-null, the returned array contains three elements. Element 0
1101 * is the java.lang.Class of which the enclosing method is a member,
1102 * and elements 1 and 2 are the java.lang.Strings for the enclosing
1103 * method's name and descriptor, respectively.
1104 */
1105 JNIEXPORT jobjectArray JNICALL
1106 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
1107
1108 /*
1109 * Virtual thread support.
1110 */
1111 JNIEXPORT void JNICALL
1112 JVM_VirtualThreadStart(JNIEnv* env, jobject vthread);
1113
1114 JNIEXPORT void JNICALL
1115 JVM_VirtualThreadEnd(JNIEnv* env, jobject vthread);
1116
1117 JNIEXPORT void JNICALL
1118 JVM_VirtualThreadMount(JNIEnv* env, jobject vthread, jboolean hide);
1119
1120 JNIEXPORT void JNICALL
1121 JVM_VirtualThreadUnmount(JNIEnv* env, jobject vthread, jboolean hide);
1122
1123 JNIEXPORT void JNICALL
1124 JVM_VirtualThreadDisableSuspend(JNIEnv* env, jclass clazz, jboolean enter);
1125
1126 JNIEXPORT void JNICALL
1127 JVM_VirtualThreadPinnedEvent(JNIEnv* env, jclass clazz, jstring op);
1128
1129 JNIEXPORT jobject JNICALL
1130 JVM_TakeVirtualThreadListToUnblock(JNIEnv* env, jclass ignored);
1131
1132 /*
1133 * Core reflection support.
1134 */
1135 JNIEXPORT jint JNICALL
1136 JVM_GetClassFileVersion(JNIEnv *env, jclass current);
1137
1138 /*
1139 * Return JNI_TRUE if warnings are printed when agents are dynamically loaded.
1140 */
1141 JNIEXPORT jboolean JNICALL
1142 JVM_PrintWarningAtDynamicAgentLoad(void);
1143
1144 /*
1145 * This structure is used by the launcher to get the default thread
1146 * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1147 * version of 1.1. As it is not supported otherwise, it has been removed
1148 * from jni.h
1149 */
1150 typedef struct JDK1_1InitArgs {
1151 jint version;
1152
1153 char **properties;
1154 jint checkSource;
1155 jint nativeStackSize;
1156 jint javaStackSize;
1157 jint minHeapSize;
1158 jint maxHeapSize;
1159 jint verifyMode;
1160 char *classpath;
1161
1162 jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1163 void (JNICALL *exit)(jint code);
1164 void (JNICALL *abort)(void);
1165
1166 jint enableClassGC;
1167 jint enableVerboseGC;
1168 jint disableAsyncGC;
1169 jint verbose;
1170 jboolean debugging;
1171 jint debugPort;
1172 } JDK1_1InitArgs;
1173
1174
1175 #ifdef __cplusplus
1176 } /* extern "C" */
1177
1178 #endif /* __cplusplus */
1179
1180 #endif /* !_JAVASOFT_JVM_H_ */