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