1 /*
2 * Copyright (c) 1997, 2018, 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 5
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 JNIEXPORT jobject JNICALL
115 JVM_InitProperties(JNIEnv *env, jobject p);
116
117
118 /*
119 * java.lang.Runtime
120 */
121 JNIEXPORT void JNICALL
122 JVM_BeforeHalt();
123
124 JNIEXPORT void JNICALL
125 JVM_Halt(jint code);
126
127 JNIEXPORT void JNICALL
128 JVM_GC(void);
129
130 /* Returns the number of real-time milliseconds that have elapsed since the
131 * least-recently-inspected heap object was last inspected by the garbage
132 * collector.
133 *
134 * For simple stop-the-world collectors this value is just the time
135 * since the most recent collection. For generational collectors it is the
136 * time since the oldest generation was most recently collected. Other
137 * collectors are free to return a pessimistic estimate of the elapsed time, or
138 * simply the time since the last full collection was performed.
139 *
140 * Note that in the presence of reference objects, a given object that is no
141 * longer strongly reachable may have to be inspected multiple times before it
142 * can be reclaimed.
143 */
144 JNIEXPORT jlong JNICALL
145 JVM_MaxObjectInspectionAge(void);
146
147 JNIEXPORT jlong JNICALL
148 JVM_TotalMemory(void);
149
150 JNIEXPORT jlong JNICALL
151 JVM_FreeMemory(void);
152
153 JNIEXPORT jlong JNICALL
154 JVM_MaxMemory(void);
155
156 JNIEXPORT jint JNICALL
157 JVM_ActiveProcessorCount(void);
158
159 JNIEXPORT void * JNICALL
160 JVM_LoadLibrary(const char *name);
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 void JNICALL
175 JVM_InitializeFromArchive(JNIEnv* env, jclass cls);
176
177 /*
178 * java.lang.Throwable
179 */
180 JNIEXPORT void JNICALL
181 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
182
183 /*
184 * java.lang.StackTraceElement
185 */
186 JNIEXPORT void JNICALL
187 JVM_InitStackTraceElementArray(JNIEnv *env, jobjectArray elements, jobject throwable);
188
189 JNIEXPORT void JNICALL
190 JVM_InitStackTraceElement(JNIEnv* env, jobject element, jobject stackFrameInfo);
191
192 /*
193 * java.lang.StackWalker
194 */
195 enum {
196 JVM_STACKWALK_FILL_CLASS_REFS_ONLY = 0x2,
197 JVM_STACKWALK_GET_CALLER_CLASS = 0x04,
198 JVM_STACKWALK_SHOW_HIDDEN_FRAMES = 0x20,
199 JVM_STACKWALK_FILL_LIVE_STACK_FRAMES = 0x100
200 };
201
202 JNIEXPORT jobject JNICALL
203 JVM_CallStackWalk(JNIEnv *env, jobject stackStream, jlong mode,
204 jint skip_frames, jint frame_count, jint start_index,
205 jobjectArray frames);
206
207 JNIEXPORT jint JNICALL
208 JVM_MoreStackWalk(JNIEnv *env, jobject stackStream, jlong mode, jlong anchor,
209 jint frame_count, jint start_index,
210 jobjectArray frames);
211
212 /*
213 * java.lang.Thread
214 */
215 JNIEXPORT void JNICALL
216 JVM_StartThread(JNIEnv *env, jobject thread);
217
218 JNIEXPORT void JNICALL
219 JVM_StopThread(JNIEnv *env, jobject thread, jobject exception);
220
221 JNIEXPORT jboolean JNICALL
222 JVM_IsThreadAlive(JNIEnv *env, jobject thread);
223
224 JNIEXPORT void JNICALL
225 JVM_SuspendThread(JNIEnv *env, jobject thread);
226
227 JNIEXPORT void JNICALL
228 JVM_ResumeThread(JNIEnv *env, jobject thread);
229
230 JNIEXPORT void JNICALL
231 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
232
233 JNIEXPORT void JNICALL
234 JVM_Yield(JNIEnv *env, jclass threadClass);
235
236 JNIEXPORT void JNICALL
237 JVM_Sleep(JNIEnv *env, jclass threadClass, jlong millis);
238
239 JNIEXPORT jobject JNICALL
240 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
241
242 JNIEXPORT jint JNICALL
243 JVM_CountStackFrames(JNIEnv *env, jobject thread);
244
245 JNIEXPORT void JNICALL
246 JVM_Interrupt(JNIEnv *env, jobject thread);
247
248 JNIEXPORT jboolean JNICALL
249 JVM_IsInterrupted(JNIEnv *env, jobject thread, jboolean clearInterrupted);
250
251 JNIEXPORT jboolean JNICALL
252 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
253
254 JNIEXPORT void JNICALL
255 JVM_DumpAllStacks(JNIEnv *env, jclass unused);
256
257 JNIEXPORT jobjectArray JNICALL
258 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
259
260 JNIEXPORT void JNICALL
261 JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);
262
263 /* getStackTrace() and getAllStackTraces() method */
264 JNIEXPORT jobjectArray JNICALL
265 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
266
267 /*
268 * java.lang.SecurityManager
269 */
270 JNIEXPORT jobjectArray JNICALL
271 JVM_GetClassContext(JNIEnv *env);
272
273 /*
274 * java.lang.Package
275 */
276 JNIEXPORT jstring JNICALL
277 JVM_GetSystemPackage(JNIEnv *env, jstring name);
278
279 JNIEXPORT jobjectArray JNICALL
280 JVM_GetSystemPackages(JNIEnv *env);
281
282 /*
283 * java.lang.ref.Reference
284 */
285 JNIEXPORT jobject JNICALL
286 JVM_GetAndClearReferencePendingList(JNIEnv *env);
287
288 JNIEXPORT jboolean JNICALL
289 JVM_HasReferencePendingList(JNIEnv *env);
290
291 JNIEXPORT void JNICALL
292 JVM_WaitForReferencePendingList(JNIEnv *env);
293
294 /*
295 * java.io.ObjectInputStream
296 */
297 JNIEXPORT jobject JNICALL
298 JVM_LatestUserDefinedLoader(JNIEnv *env);
299
300 /*
301 * java.lang.reflect.Array
302 */
303 JNIEXPORT jint JNICALL
304 JVM_GetArrayLength(JNIEnv *env, jobject arr);
305
306 JNIEXPORT jobject JNICALL
307 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
308
309 JNIEXPORT jvalue JNICALL
310 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
311
312 JNIEXPORT void JNICALL
313 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
314
315 JNIEXPORT void JNICALL
316 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
317 unsigned char vCode);
318
319 JNIEXPORT jobject JNICALL
320 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
321
322 JNIEXPORT jobject JNICALL
323 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
324
325
326 /*
327 * Returns the immediate caller class of the native method invoking
328 * JVM_GetCallerClass. The Method.invoke and other frames due to
329 * reflection machinery are skipped.
330 *
331 * The caller is expected to be marked with
332 * jdk.internal.reflect.CallerSensitive. The JVM will throw an
333 * error if it is not marked properly.
334 */
335 JNIEXPORT jclass JNICALL
336 JVM_GetCallerClass(JNIEnv *env);
337
338
339 /*
340 * Find primitive classes
341 * utf: class name
342 */
343 JNIEXPORT jclass JNICALL
344 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
345
346
347 /*
348 * Find a class from a boot class loader. Returns NULL if class not found.
349 */
350 JNIEXPORT jclass JNICALL
351 JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);
352
353 /*
354 * Find a class from a given class loader. Throws ClassNotFoundException.
355 * name: name of class
356 * init: whether initialization is done
357 * loader: class loader to look up the class. This may not be the same as the caller's
358 * class loader.
359 * caller: initiating class. The initiating class may be null when a security
360 * manager is not installed.
361 */
362 JNIEXPORT jclass JNICALL
363 JVM_FindClassFromCaller(JNIEnv *env, const char *name, jboolean init,
364 jobject loader, jclass caller);
365
366 /*
367 * Find a class from a given class.
368 */
369 JNIEXPORT jclass JNICALL
370 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
371 jclass from);
372
373 /* Find a loaded class cached by the VM */
374 JNIEXPORT jclass JNICALL
375 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
376
377 /* Define a class */
378 JNIEXPORT jclass JNICALL
379 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
380 jsize len, jobject pd);
381
382 /* Define a class with a source (added in JDK1.5) */
383 JNIEXPORT jclass JNICALL
384 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
385 const jbyte *buf, jsize len, jobject pd,
386 const char *source);
387
388 /*
389 * Module support funcions
390 */
391
392 /*
393 * Define a module with the specified packages and bind the module to the
394 * given class loader.
395 * module: module to define
396 * is_open: specifies if module is open (currently ignored)
397 * version: the module version
398 * location: the module location
399 * packages: list of packages in the module
400 * num_packages: number of packages in the module
401 */
402 JNIEXPORT void JNICALL
403 JVM_DefineModule(JNIEnv *env, jobject module, jboolean is_open, jstring version,
404 jstring location, const char* const* packages, jsize num_packages);
405
406 /*
407 * Set the boot loader's unnamed module.
408 * module: boot loader's unnamed module
409 */
410 JNIEXPORT void JNICALL
411 JVM_SetBootLoaderUnnamedModule(JNIEnv *env, jobject module);
412
413 /*
414 * Do a qualified export of a package.
415 * from_module: module containing the package to export
416 * package: name of the package to export
417 * to_module: module to export the package to
418 */
419 JNIEXPORT void JNICALL
420 JVM_AddModuleExports(JNIEnv *env, jobject from_module, const char* package, jobject to_module);
421
422 /*
423 * Do an export of a package to all unnamed modules.
424 * from_module: module containing the package to export
425 * package: name of the package to export to all unnamed modules
426 */
427 JNIEXPORT void JNICALL
428 JVM_AddModuleExportsToAllUnnamed(JNIEnv *env, jobject from_module, const char* package);
429
430 /*
431 * Do an unqualified export of a package.
432 * from_module: module containing the package to export
433 * package: name of the package to export
434 */
435 JNIEXPORT void JNICALL
436 JVM_AddModuleExportsToAll(JNIEnv *env, jobject from_module, const char* package);
437
438 /*
439 * Add a module to the list of modules that a given module can read.
440 * from_module: module requesting read access
441 * source_module: module that from_module wants to read
442 */
443 JNIEXPORT void JNICALL
444 JVM_AddReadsModule(JNIEnv *env, jobject from_module, jobject source_module);
445
446 /*
447 * Reflection support functions
448 */
449
450 JNIEXPORT jstring JNICALL
451 JVM_GetClassName(JNIEnv *env, jclass cls);
452
453 JNIEXPORT jobjectArray JNICALL
454 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
455
456 JNIEXPORT jboolean JNICALL
457 JVM_IsInterface(JNIEnv *env, jclass cls);
458
459 JNIEXPORT jobjectArray JNICALL
460 JVM_GetClassSigners(JNIEnv *env, jclass cls);
461
462 JNIEXPORT void JNICALL
463 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
464
465 JNIEXPORT jobject JNICALL
466 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
467
468 JNIEXPORT jboolean JNICALL
469 JVM_IsArrayClass(JNIEnv *env, jclass cls);
470
471 JNIEXPORT jboolean JNICALL
472 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
473
474 JNIEXPORT jint JNICALL
475 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
476
477 JNIEXPORT jobjectArray JNICALL
478 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
479
480 JNIEXPORT jclass JNICALL
481 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
482
483 JNIEXPORT jstring JNICALL
484 JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);
485
486 /* Generics support (JDK 1.5) */
487 JNIEXPORT jstring JNICALL
488 JVM_GetClassSignature(JNIEnv *env, jclass cls);
489
490 /* Annotations support (JDK 1.5) */
491 JNIEXPORT jbyteArray JNICALL
492 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
493
494 /* Type use annotations support (JDK 1.8) */
495
496 JNIEXPORT jbyteArray JNICALL
497 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
498
499 JNIEXPORT jbyteArray JNICALL
500 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
501
502 JNIEXPORT jbyteArray JNICALL
503 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
504
505 /*
506 * New (JDK 1.4) reflection implementation
507 */
508
509 JNIEXPORT jobjectArray JNICALL
510 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
511
512 JNIEXPORT jobjectArray JNICALL
513 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
514
515 JNIEXPORT jobjectArray JNICALL
516 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
517
518 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
519 This returns the access flags for the class as specified in the
520 class file rather than searching the InnerClasses attribute (if
521 present) to find the source-level access flags. Only the values of
522 the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
523 valid. */
524 JNIEXPORT jint JNICALL
525 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
526
527 /* Nestmates - since JDK 11 */
528
529 JNIEXPORT jboolean JNICALL
530 JVM_AreNestMates(JNIEnv *env, jclass current, jclass member);
531
532 JNIEXPORT jclass JNICALL
533 JVM_GetNestHost(JNIEnv *env, jclass current);
534
535 JNIEXPORT jobjectArray JNICALL
536 JVM_GetNestMembers(JNIEnv *env, jclass current);
537
538 /* The following two reflection routines are still needed due to startup time issues */
539 /*
540 * java.lang.reflect.Method
541 */
542 JNIEXPORT jobject JNICALL
543 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
544
545 /*
546 * java.lang.reflect.Constructor
547 */
548 JNIEXPORT jobject JNICALL
549 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
550
551 /*
552 * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
553 */
554
555 JNIEXPORT jobject JNICALL
556 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
557
558 JNIEXPORT jclass JNICALL JVM_ConstantPool1GetHolder
559 (JNIEnv *env, jobject jcpool);
560
561 JNIEXPORT jint JNICALL JVM_ConstantPool1GetSize
562 (JNIEnv *env, jobject jcpool);
563
564 JNIEXPORT jint JNICALL JVM_ConstantPool1GetWordCountAt
565 (JNIEnv *env, jobject jcpool, jint index);
566
567 JNIEXPORT jobject JNICALL JVM_ConstantPool1GetRefAt
568 (JNIEnv *env, jobject jcpool, jint index, jint word, jbyte resolving, jobject if_not_present);
569
570 JNIEXPORT void JNICALL JVM_ConstantPool1CopyOutRefsAt
571 (JNIEnv *env, jobject jcpool, jint index, jint start_word, jint end_word,
572 jobject buf, jint buf_pos, jbyte resolving,
573 jobject if_not_present, jobject if_null_constant, jboolean skip_non_null);
574
575 JNIEXPORT jint JNICALL JVM_ConstantPool1GetWordAt
576 (JNIEnv *env, jobject jcpool, jint index, jint word);
577
578 JNIEXPORT jint JNICALL JVM_ConstantPool1GetIntAt
579 (JNIEnv *env, jobject jcpool, jint index);
580
581 JNIEXPORT jlong JNICALL JVM_ConstantPool1GetLongAt
582 (JNIEnv *env, jobject jcpool, jint index);
583
584 JNIEXPORT jfloat JNICALL JVM_ConstantPool1GetFloatAt
585 (JNIEnv *env, jobject jcpool, jint index);
586
587 JNIEXPORT jdouble JNICALL JVM_ConstantPool1GetDoubleAt
588 (JNIEnv *env, jobject jcpool, jint index);
589
590 JNIEXPORT jbyte JNICALL JVM_ConstantPool1GetTagAt
591 (JNIEnv *env, jobject jcpool, jint index);
592
593 JNIEXPORT jbyteArray JNICALL JVM_ConstantPool1GetTags
594 (JNIEnv *env, jobject jcpool);
595
596 /*
597 * Parameter reflection
598 */
599
600 JNIEXPORT jobjectArray JNICALL
601 JVM_GetMethodParameters(JNIEnv *env, jobject method);
602
603 /*
604 * java.security.*
605 */
606
607 JNIEXPORT jobject JNICALL
608 JVM_DoPrivileged(JNIEnv *env, jclass cls,
609 jobject action, jobject context, jboolean wrapException);
610
611 JNIEXPORT jobject JNICALL
612 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
613
614 JNIEXPORT jobject JNICALL
615 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
616
617 /*
618 * Signal support, used to implement the shutdown sequence. Every VM must
619 * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
620 * (^C) and the latter for external termination (kill, system shutdown, etc.).
621 * Other platform-dependent signal values may also be supported.
622 */
623
624 JNIEXPORT void * JNICALL
625 JVM_RegisterSignal(jint sig, void *handler);
626
627 JNIEXPORT jboolean JNICALL
628 JVM_RaiseSignal(jint sig);
629
630 JNIEXPORT jint JNICALL
631 JVM_FindSignal(const char *name);
632
633 /*
634 * Retrieve the assertion directives for the specified class.
635 */
636 JNIEXPORT jboolean JNICALL
637 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
638
639 /*
640 * Retrieve the assertion directives from the VM.
641 */
642 JNIEXPORT jobject JNICALL
643 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
644
645 /*
646 * java.util.concurrent.atomic.AtomicLong
647 */
648 JNIEXPORT jboolean JNICALL
649 JVM_SupportsCX8(void);
650
651 /*
652 * com.sun.dtrace.jsdt support
653 */
654
655 #define JVM_TRACING_DTRACE_VERSION 1
656
657 /*
658 * Structure to pass one probe description to JVM
659 */
660 typedef struct {
661 jmethodID method;
662 jstring function;
663 jstring name;
664 void* reserved[4]; // for future use
665 } JVM_DTraceProbe;
666
667 /**
668 * Encapsulates the stability ratings for a DTrace provider field
669 */
670 typedef struct {
671 jint nameStability;
672 jint dataStability;
673 jint dependencyClass;
674 } JVM_DTraceInterfaceAttributes;
675
676 /*
677 * Structure to pass one provider description to JVM
678 */
679 typedef struct {
680 jstring name;
681 JVM_DTraceProbe* probes;
682 jint probe_count;
683 JVM_DTraceInterfaceAttributes providerAttributes;
684 JVM_DTraceInterfaceAttributes moduleAttributes;
685 JVM_DTraceInterfaceAttributes functionAttributes;
686 JVM_DTraceInterfaceAttributes nameAttributes;
687 JVM_DTraceInterfaceAttributes argsAttributes;
688 void* reserved[4]; // for future use
689 } JVM_DTraceProvider;
690
691 /*
692 * Get the version number the JVM was built with
693 */
694 JNIEXPORT jint JNICALL
695 JVM_DTraceGetVersion(JNIEnv* env);
696
697 /*
698 * Register new probe with given signature, return global handle
699 *
700 * The version passed in is the version that the library code was
701 * built with.
702 */
703 JNIEXPORT jlong JNICALL
704 JVM_DTraceActivate(JNIEnv* env, jint version, jstring module_name,
705 jint providers_count, JVM_DTraceProvider* providers);
706
707 /*
708 * Check JSDT probe
709 */
710 JNIEXPORT jboolean JNICALL
711 JVM_DTraceIsProbeEnabled(JNIEnv* env, jmethodID method);
712
713 /*
714 * Destroy custom DOF
715 */
716 JNIEXPORT void JNICALL
717 JVM_DTraceDispose(JNIEnv* env, jlong activation_handle);
718
719 /*
720 * Check to see if DTrace is supported by OS
721 */
722 JNIEXPORT jboolean JNICALL
723 JVM_DTraceIsSupported(JNIEnv* env);
724
725 /*************************************************************************
726 PART 2: Support for the Verifier and Class File Format Checker
727 ************************************************************************/
728 /*
729 * Return the class name in UTF format. The result is valid
730 * until JVM_ReleaseUTf is called.
731 *
732 * The caller must treat the string as a constant and not modify it
733 * in any way.
734 */
735 JNIEXPORT const char * JNICALL
736 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
737
738 /*
739 * Returns the constant pool types in the buffer provided by "types."
740 */
741 JNIEXPORT void JNICALL
742 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
743
744 /*
745 * Returns the number of Constant Pool entries.
746 */
747 JNIEXPORT jint JNICALL
748 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
749
750 /*
751 * Returns the number of *declared* fields or methods.
752 */
753 JNIEXPORT jint JNICALL
754 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
755
756 JNIEXPORT jint JNICALL
757 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
758
759 /*
760 * Returns the CP indexes of exceptions raised by a given method.
761 * Places the result in the given buffer.
762 *
763 * The method is identified by method_index.
764 */
765 JNIEXPORT void JNICALL
766 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
767 unsigned short *exceptions);
768 /*
769 * Returns the number of exceptions raised by a given method.
770 * The method is identified by method_index.
771 */
772 JNIEXPORT jint JNICALL
773 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
774
775 /*
776 * Returns the byte code sequence of a given method.
777 * Places the result in the given buffer.
778 *
779 * The method is identified by method_index.
780 */
781 JNIEXPORT void JNICALL
782 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
783 unsigned char *code);
784
785 /*
786 * Returns the length of the byte code sequence of a given method.
787 * The method is identified by method_index.
788 */
789 JNIEXPORT jint JNICALL
790 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
791
792 /*
793 * A structure used to a capture exception table entry in a Java method.
794 */
795 typedef struct {
796 jint start_pc;
797 jint end_pc;
798 jint handler_pc;
799 jint catchType;
800 } JVM_ExceptionTableEntryType;
801
802 /*
803 * Returns the exception table entry at entry_index of a given method.
804 * Places the result in the given buffer.
805 *
806 * The method is identified by method_index.
807 */
808 JNIEXPORT void JNICALL
809 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
810 jint entry_index,
811 JVM_ExceptionTableEntryType *entry);
812
813 /*
814 * Returns the length of the exception table of a given method.
815 * The method is identified by method_index.
816 */
817 JNIEXPORT jint JNICALL
818 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
819
820 /*
821 * Returns the modifiers of a given field.
822 * The field is identified by field_index.
823 */
824 JNIEXPORT jint JNICALL
825 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
826
827 /*
828 * Returns the modifiers of a given method.
829 * The method is identified by method_index.
830 */
831 JNIEXPORT jint JNICALL
832 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
833
834 /*
835 * Returns the number of local variables of a given method.
836 * The method is identified by method_index.
837 */
838 JNIEXPORT jint JNICALL
839 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
840
841 /*
842 * Returns the number of arguments (including this pointer) of a given method.
843 * The method is identified by method_index.
844 */
845 JNIEXPORT jint JNICALL
846 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
847
848 /*
849 * Returns the maximum amount of stack (in words) used by a given method.
850 * The method is identified by method_index.
851 */
852 JNIEXPORT jint JNICALL
853 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
854
855 /*
856 * Is a given method a constructor.
857 * The method is identified by method_index.
858 */
859 JNIEXPORT jboolean JNICALL
860 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
861
862 /*
863 * Is the given method generated by the VM.
864 * The method is identified by method_index.
865 */
866 JNIEXPORT jboolean JNICALL
867 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
868
869 /*
870 * Returns the name of a given method in UTF format.
871 * The result remains valid until JVM_ReleaseUTF is called.
872 *
873 * The caller must treat the string as a constant and not modify it
874 * in any way.
875 */
876 JNIEXPORT const char * JNICALL
877 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
878
879 /*
880 * Returns the signature of a given method in UTF format.
881 * The result remains valid until JVM_ReleaseUTF is called.
882 *
883 * The caller must treat the string as a constant and not modify it
884 * in any way.
885 */
886 JNIEXPORT const char * JNICALL
887 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
888
889 /*
890 * Returns the name of the field referred to at a given constant pool
891 * index.
892 *
893 * The result is in UTF format and remains valid until JVM_ReleaseUTF
894 * is called.
895 *
896 * The caller must treat the string as a constant and not modify it
897 * in any way.
898 */
899 JNIEXPORT const char * JNICALL
900 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
901
902 /*
903 * Returns the name of the method referred to at a given constant pool
904 * index.
905 *
906 * The result is in UTF format and remains valid until JVM_ReleaseUTF
907 * is called.
908 *
909 * The caller must treat the string as a constant and not modify it
910 * in any way.
911 */
912 JNIEXPORT const char * JNICALL
913 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
914
915 /*
916 * Returns the signature of the method referred to at a given constant pool
917 * index.
918 *
919 * The result is in UTF format and remains valid until JVM_ReleaseUTF
920 * is called.
921 *
922 * The caller must treat the string as a constant and not modify it
923 * in any way.
924 */
925 JNIEXPORT const char * JNICALL
926 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
927
928 /*
929 * Returns the signature of the field referred to at a given constant pool
930 * index.
931 *
932 * The result is in UTF format and remains valid until JVM_ReleaseUTF
933 * is called.
934 *
935 * The caller must treat the string as a constant and not modify it
936 * in any way.
937 */
938 JNIEXPORT const char * JNICALL
939 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
940
941 /*
942 * Returns the class name referred to at a given constant pool index.
943 *
944 * The result is in UTF format and remains valid until JVM_ReleaseUTF
945 * is called.
946 *
947 * The caller must treat the string as a constant and not modify it
948 * in any way.
949 */
950 JNIEXPORT const char * JNICALL
951 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
952
953 /*
954 * Returns the class name referred to at a given constant pool index.
955 *
956 * The constant pool entry must refer to a CONSTANT_Fieldref.
957 *
958 * The result is in UTF format and remains valid until JVM_ReleaseUTF
959 * is called.
960 *
961 * The caller must treat the string as a constant and not modify it
962 * in any way.
963 */
964 JNIEXPORT const char * JNICALL
965 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
966
967 /*
968 * Returns the class name referred to at a given constant pool index.
969 *
970 * The constant pool entry must refer to CONSTANT_Methodref or
971 * CONSTANT_InterfaceMethodref.
972 *
973 * The result is in UTF format and remains valid until JVM_ReleaseUTF
974 * is called.
975 *
976 * The caller must treat the string as a constant and not modify it
977 * in any way.
978 */
979 JNIEXPORT const char * JNICALL
980 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
981
982 /*
983 * Returns the modifiers of a field in calledClass. The field is
984 * referred to in class cb at constant pool entry index.
985 *
986 * The caller must treat the string as a constant and not modify it
987 * in any way.
988 *
989 * Returns -1 if the field does not exist in calledClass.
990 */
991 JNIEXPORT jint JNICALL
992 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
993
994 /*
995 * Returns the modifiers of a method in calledClass. The method is
996 * referred to in class cb at constant pool entry index.
997 *
998 * Returns -1 if the method does not exist in calledClass.
999 */
1000 JNIEXPORT jint JNICALL
1001 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1002
1003 /*
1004 * Releases the UTF string obtained from the VM.
1005 */
1006 JNIEXPORT void JNICALL
1007 JVM_ReleaseUTF(const char *utf);
1008
1009 /*
1010 * Compare if two classes are in the same package.
1011 */
1012 JNIEXPORT jboolean JNICALL
1013 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
1014
1015 /* Get classfile constants */
1016 #include "classfile_constants.h"
1017
1018 /*
1019 * A function defined by the byte-code verifier and called by the VM.
1020 * This is not a function implemented in the VM.
1021 *
1022 * Returns JNI_FALSE if verification fails. A detailed error message
1023 * will be places in msg_buf, whose length is specified by buf_len.
1024 */
1025 typedef jboolean (*verifier_fn_t)(JNIEnv *env,
1026 jclass cb,
1027 char * msg_buf,
1028 jint buf_len);
1029
1030
1031 /*
1032 * Support for a VM-independent class format checker.
1033 */
1034 typedef struct {
1035 unsigned long code; /* byte code */
1036 unsigned long excs; /* exceptions */
1037 unsigned long etab; /* catch table */
1038 unsigned long lnum; /* line number */
1039 unsigned long lvar; /* local vars */
1040 } method_size_info;
1041
1042 typedef struct {
1043 unsigned int constants; /* constant pool */
1044 unsigned int fields;
1045 unsigned int methods;
1046 unsigned int interfaces;
1047 unsigned int fields2; /* number of static 2-word fields */
1048 unsigned int innerclasses; /* # of records in InnerClasses attr */
1049
1050 method_size_info clinit; /* memory used in clinit */
1051 method_size_info main; /* used everywhere else */
1052 } class_size_info;
1053
1054 /*
1055 * Functions defined in libjava.so to perform string conversions.
1056 *
1057 */
1058
1059 typedef jstring (*to_java_string_fn_t)(JNIEnv *env, char *str);
1060
1061 typedef char *(*to_c_string_fn_t)(JNIEnv *env, jstring s, jboolean *b);
1062
1063 /* This is the function defined in libjava.so that performs class
1064 * format checks. This functions fills in size information about
1065 * the class file and returns:
1066 *
1067 * 0: good
1068 * -1: out of memory
1069 * -2: bad format
1070 * -3: unsupported version
1071 * -4: bad class name
1072 */
1073
1074 typedef jint (*check_format_fn_t)(char *class_name,
1075 unsigned char *data,
1076 unsigned int data_size,
1077 class_size_info *class_size,
1078 char *message_buffer,
1079 jint buffer_length,
1080 jboolean measure_only,
1081 jboolean check_relaxed);
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
1261 /* The following bits represents new JDK supports that VM has dependency on.
1262 * VM implementation can use these bits to determine which JDK version
1263 * and support it has to maintain runtime compatibility.
1264 *
1265 * When a new bit is added in a minor or update release, make sure
1266 * the new bit is also added in the main/baseline.
1267 */
1268 unsigned int thread_park_blocker : 1;
1269 unsigned int post_vm_init_hook_enabled : 1;
1270 unsigned int pending_list_uses_discovered_field : 1;
1271 unsigned int : 29;
1272 unsigned int : 32;
1273 unsigned int : 32;
1274 } jdk_version_info;
1275
1276 #define JDK_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1277 #define JDK_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1278 #define JDK_VERSION_SECURITY(version) ((version & 0x0000FF00) >> 8)
1279 #define JDK_VERSION_BUILD(version) ((version & 0x000000FF))
1280
1281 /*
1282 * This is the function JDK_GetVersionInfo0 defined in libjava.so
1283 * that is dynamically looked up by JVM.
1284 */
1285 typedef void (*jdk_version_info_fn_t)(jdk_version_info* info, size_t info_size);
1286
1287 /*
1288 * This structure is used by the launcher to get the default thread
1289 * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1290 * version of 1.1. As it is not supported otherwise, it has been removed
1291 * from jni.h
1292 */
1293 typedef struct JDK1_1InitArgs {
1294 jint version;
1295
1296 char **properties;
1297 jint checkSource;
1298 jint nativeStackSize;
1299 jint javaStackSize;
1300 jint minHeapSize;
1301 jint maxHeapSize;
1302 jint verifyMode;
1303 char *classpath;
1304
1305 jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1306 void (JNICALL *exit)(jint code);
1307 void (JNICALL *abort)(void);
1308
1309 jint enableClassGC;
1310 jint enableVerboseGC;
1311 jint disableAsyncGC;
1312 jint verbose;
1313 jboolean debugging;
1314 jint debugPort;
1315 } JDK1_1InitArgs;
1316
1317
1318 #ifdef __cplusplus
1319 } /* extern "C" */
1320
1321 #endif /* __cplusplus */
1322
1323 #endif /* !_JAVASOFT_JVM_H_ */