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