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