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