1 /*
2 * Copyright (c) 1997, 2015, 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 nerwork 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 jint JNICALL
175 JVM_GetStackTraceDepth(JNIEnv *env, jobject throwable);
176
177 JNIEXPORT jobject JNICALL
178 JVM_GetStackTraceElement(JNIEnv *env, jobject throwable, jint index);
179
180 /*
181 * java.lang.StackWalker
182 */
183 enum {
184 JVM_STACKWALK_FILL_CLASS_REFS_ONLY = 0x2,
185 JVM_STACKWALK_FILTER_FILL_IN_STACK_TRACE = 0x10,
186 JVM_STACKWALK_SHOW_HIDDEN_FRAMES = 0x20,
187 JVM_STACKWALK_FILL_LIVE_STACK_FRAMES = 0x100
188 };
189
190 JNIEXPORT jobject JNICALL
191 JVM_CallStackWalk(JNIEnv *env, jobject stackStream, jlong mode,
192 jint skip_frames, jint frame_count, jint start_index,
193 jobjectArray classes,
194 jobjectArray frames);
195
196 JNIEXPORT jint JNICALL
197 JVM_MoreStackWalk(JNIEnv *env, jobject stackStream, jlong mode, jlong anchor,
198 jint frame_count, jint start_index,
199 jobjectArray classes,
200 jobjectArray frames);
201
202 JNIEXPORT void JNICALL
203 JVM_FillStackFrames(JNIEnv* env, jclass cls,
204 jint start_index,
205 jobjectArray stackFrames,
206 jint from_index, jint toIndex);
207
208 JNIEXPORT void JNICALL
209 JVM_SetMethodInfo(JNIEnv* env, jobject frame);
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 * Reflection support functions
394 */
395
396 JNIEXPORT jstring JNICALL
397 JVM_GetClassName(JNIEnv *env, jclass cls);
398
399 JNIEXPORT jobjectArray JNICALL
400 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
401
402 JNIEXPORT jboolean JNICALL
403 JVM_IsInterface(JNIEnv *env, jclass cls);
404
405 JNIEXPORT jobjectArray JNICALL
406 JVM_GetClassSigners(JNIEnv *env, jclass cls);
407
408 JNIEXPORT void JNICALL
409 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
410
411 JNIEXPORT jobject JNICALL
412 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
413
414 JNIEXPORT jboolean JNICALL
415 JVM_IsArrayClass(JNIEnv *env, jclass cls);
416
417 JNIEXPORT jboolean JNICALL
418 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
419
420 JNIEXPORT jint JNICALL
421 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
422
423 JNIEXPORT jobjectArray JNICALL
424 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
425
426 JNIEXPORT jclass JNICALL
427 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
428
429 JNIEXPORT jstring JNICALL
430 JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);
431
432 /* Generics support (JDK 1.5) */
433 JNIEXPORT jstring JNICALL
434 JVM_GetClassSignature(JNIEnv *env, jclass cls);
435
436 /* Annotations support (JDK 1.5) */
437 JNIEXPORT jbyteArray JNICALL
438 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
439
440 /* Type use annotations support (JDK 1.8) */
441
442 JNIEXPORT jbyteArray JNICALL
443 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
444
445 JNIEXPORT jbyteArray JNICALL
446 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
447
448 JNIEXPORT jbyteArray JNICALL
449 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
450
451 /*
452 * New (JDK 1.4) reflection implementation
453 */
454
455 JNIEXPORT jobjectArray JNICALL
456 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
457
458 JNIEXPORT jobjectArray JNICALL
459 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
460
461 JNIEXPORT jobjectArray JNICALL
462 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
463
464 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
465 This returns the access flags for the class as specified in the
466 class file rather than searching the InnerClasses attribute (if
467 present) to find the source-level access flags. Only the values of
468 the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
469 valid. */
470 JNIEXPORT jint JNICALL
471 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
472
473 /* The following two reflection routines are still needed due to startup time issues */
474 /*
475 * java.lang.reflect.Method
476 */
477 JNIEXPORT jobject JNICALL
478 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
479
480 /*
481 * java.lang.reflect.Constructor
482 */
483 JNIEXPORT jobject JNICALL
484 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
485
486 /*
487 * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
488 */
489
490 JNIEXPORT jobject JNICALL
491 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
492
493 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
494 (JNIEnv *env, jobject unused, jobject jcpool);
495
496 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
497 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
498
499 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
500 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
501
502 JNIEXPORT jint JNICALL JVM_ConstantPoolGetClassRefIndexAt
503 (JNIEnv *env, jobject obj, jobject unused, jint index);
504
505 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
506 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
507
508 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
509 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
510
511 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
512 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
513
514 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
515 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
516
517 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
518 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
519
520 JNIEXPORT jint JNICALL JVM_ConstantPoolGetNameAndTypeRefIndexAt
521 (JNIEnv *env, jobject obj, jobject unused, jint index);
522
523 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetNameAndTypeRefInfoAt
524 (JNIEnv *env, jobject obj, jobject unused, jint index);
525
526 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
527 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
528
529 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
530 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
531
532 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
533 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
534
535 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
536 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
537
538 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
539 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
540
541 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
542 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
543
544 JNIEXPORT jbyte JNICALL JVM_ConstantPoolGetTagAt
545 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
546
547 /*
548 * Parameter reflection
549 */
550
551 JNIEXPORT jobjectArray JNICALL
552 JVM_GetMethodParameters(JNIEnv *env, jobject method);
553
554 /*
555 * java.security.*
556 */
557
558 JNIEXPORT jobject JNICALL
559 JVM_DoPrivileged(JNIEnv *env, jclass cls,
560 jobject action, jobject context, jboolean wrapException);
561
562 JNIEXPORT jobject JNICALL
563 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
564
565 JNIEXPORT jobject JNICALL
566 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
567
568 /*
569 * Signal support, used to implement the shutdown sequence. Every VM must
570 * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
571 * (^C) and the latter for external termination (kill, system shutdown, etc.).
572 * Other platform-dependent signal values may also be supported.
573 */
574
575 JNIEXPORT void * JNICALL
576 JVM_RegisterSignal(jint sig, void *handler);
577
578 JNIEXPORT jboolean JNICALL
579 JVM_RaiseSignal(jint sig);
580
581 JNIEXPORT jint JNICALL
582 JVM_FindSignal(const char *name);
583
584 /*
585 * Retrieve the assertion directives for the specified class.
586 */
587 JNIEXPORT jboolean JNICALL
588 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
589
590 /*
591 * Retrieve the assertion directives from the VM.
592 */
593 JNIEXPORT jobject JNICALL
594 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
595
596 /*
597 * java.util.concurrent.atomic.AtomicLong
598 */
599 JNIEXPORT jboolean JNICALL
600 JVM_SupportsCX8(void);
601
602 /*
603 * com.sun.dtrace.jsdt support
604 */
605
606 #define JVM_TRACING_DTRACE_VERSION 1
607
608 /*
609 * Structure to pass one probe description to JVM
610 */
611 typedef struct {
612 jmethodID method;
613 jstring function;
614 jstring name;
615 void* reserved[4]; // for future use
616 } JVM_DTraceProbe;
617
618 /**
619 * Encapsulates the stability ratings for a DTrace provider field
620 */
621 typedef struct {
622 jint nameStability;
623 jint dataStability;
624 jint dependencyClass;
625 } JVM_DTraceInterfaceAttributes;
626
627 /*
628 * Structure to pass one provider description to JVM
629 */
630 typedef struct {
631 jstring name;
632 JVM_DTraceProbe* probes;
633 jint probe_count;
634 JVM_DTraceInterfaceAttributes providerAttributes;
635 JVM_DTraceInterfaceAttributes moduleAttributes;
636 JVM_DTraceInterfaceAttributes functionAttributes;
637 JVM_DTraceInterfaceAttributes nameAttributes;
638 JVM_DTraceInterfaceAttributes argsAttributes;
639 void* reserved[4]; // for future use
640 } JVM_DTraceProvider;
641
642 /*
643 * Get the version number the JVM was built with
644 */
645 JNIEXPORT jint JNICALL
646 JVM_DTraceGetVersion(JNIEnv* env);
647
648 /*
649 * Register new probe with given signature, return global handle
650 *
651 * The version passed in is the version that the library code was
652 * built with.
653 */
654 JNIEXPORT jlong JNICALL
655 JVM_DTraceActivate(JNIEnv* env, jint version, jstring module_name,
656 jint providers_count, JVM_DTraceProvider* providers);
657
658 /*
659 * Check JSDT probe
660 */
661 JNIEXPORT jboolean JNICALL
662 JVM_DTraceIsProbeEnabled(JNIEnv* env, jmethodID method);
663
664 /*
665 * Destroy custom DOF
666 */
667 JNIEXPORT void JNICALL
668 JVM_DTraceDispose(JNIEnv* env, jlong activation_handle);
669
670 /*
671 * Check to see if DTrace is supported by OS
672 */
673 JNIEXPORT jboolean JNICALL
674 JVM_DTraceIsSupported(JNIEnv* env);
675
676 /*************************************************************************
677 PART 2: Support for the Verifier and Class File Format Checker
678 ************************************************************************/
679 /*
680 * Return the class name in UTF format. The result is valid
681 * until JVM_ReleaseUTf is called.
682 *
683 * The caller must treat the string as a constant and not modify it
684 * in any way.
685 */
686 JNIEXPORT const char * JNICALL
687 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
688
689 /*
690 * Returns the constant pool types in the buffer provided by "types."
691 */
692 JNIEXPORT void JNICALL
693 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
694
695 /*
696 * Returns the number of Constant Pool entries.
697 */
698 JNIEXPORT jint JNICALL
699 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
700
701 /*
702 * Returns the number of *declared* fields or methods.
703 */
704 JNIEXPORT jint JNICALL
705 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
706
707 JNIEXPORT jint JNICALL
708 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
709
710 /*
711 * Returns the CP indexes of exceptions raised by a given method.
712 * Places the result in the given buffer.
713 *
714 * The method is identified by method_index.
715 */
716 JNIEXPORT void JNICALL
717 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
718 unsigned short *exceptions);
719 /*
720 * Returns the number of exceptions raised by a given method.
721 * The method is identified by method_index.
722 */
723 JNIEXPORT jint JNICALL
724 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
725
726 /*
727 * Returns the byte code sequence of a given method.
728 * Places the result in the given buffer.
729 *
730 * The method is identified by method_index.
731 */
732 JNIEXPORT void JNICALL
733 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
734 unsigned char *code);
735
736 /*
737 * Returns the length of the byte code sequence of a given method.
738 * The method is identified by method_index.
739 */
740 JNIEXPORT jint JNICALL
741 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
742
743 /*
744 * A structure used to a capture exception table entry in a Java method.
745 */
746 typedef struct {
747 jint start_pc;
748 jint end_pc;
749 jint handler_pc;
750 jint catchType;
751 } JVM_ExceptionTableEntryType;
752
753 /*
754 * Returns the exception table entry at entry_index of a given method.
755 * Places the result in the given buffer.
756 *
757 * The method is identified by method_index.
758 */
759 JNIEXPORT void JNICALL
760 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
761 jint entry_index,
762 JVM_ExceptionTableEntryType *entry);
763
764 /*
765 * Returns the length of the exception table of a given method.
766 * The method is identified by method_index.
767 */
768 JNIEXPORT jint JNICALL
769 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
770
771 /*
772 * Returns the modifiers of a given field.
773 * The field is identified by field_index.
774 */
775 JNIEXPORT jint JNICALL
776 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
777
778 /*
779 * Returns the modifiers of a given method.
780 * The method is identified by method_index.
781 */
782 JNIEXPORT jint JNICALL
783 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
784
785 /*
786 * Returns the number of local variables of a given method.
787 * The method is identified by method_index.
788 */
789 JNIEXPORT jint JNICALL
790 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
791
792 /*
793 * Returns the number of arguments (including this pointer) of a given method.
794 * The method is identified by method_index.
795 */
796 JNIEXPORT jint JNICALL
797 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
798
799 /*
800 * Returns the maximum amount of stack (in words) used by a given method.
801 * The method is identified by method_index.
802 */
803 JNIEXPORT jint JNICALL
804 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
805
806 /*
807 * Is a given method a constructor.
808 * The method is identified by method_index.
809 */
810 JNIEXPORT jboolean JNICALL
811 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
812
813 /*
814 * Is the given method generated by the VM.
815 * The method is identified by method_index.
816 */
817 JNIEXPORT jboolean JNICALL
818 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
819
820 /*
821 * Returns the name of a given method in UTF format.
822 * The result remains valid until JVM_ReleaseUTF is called.
823 *
824 * The caller must treat the string as a constant and not modify it
825 * in any way.
826 */
827 JNIEXPORT const char * JNICALL
828 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
829
830 /*
831 * Returns the signature of a given method in UTF format.
832 * The result remains valid until JVM_ReleaseUTF is called.
833 *
834 * The caller must treat the string as a constant and not modify it
835 * in any way.
836 */
837 JNIEXPORT const char * JNICALL
838 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
839
840 /*
841 * Returns the name of the field referred to at a given constant pool
842 * index.
843 *
844 * The result is in UTF format and remains valid until JVM_ReleaseUTF
845 * is called.
846 *
847 * The caller must treat the string as a constant and not modify it
848 * in any way.
849 */
850 JNIEXPORT const char * JNICALL
851 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
852
853 /*
854 * Returns the name of the method referred to at a given constant pool
855 * index.
856 *
857 * The result is in UTF format and remains valid until JVM_ReleaseUTF
858 * is called.
859 *
860 * The caller must treat the string as a constant and not modify it
861 * in any way.
862 */
863 JNIEXPORT const char * JNICALL
864 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
865
866 /*
867 * Returns the signature of the method referred to at a given constant pool
868 * index.
869 *
870 * The result is in UTF format and remains valid until JVM_ReleaseUTF
871 * 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_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
878
879 /*
880 * Returns the signature of the field referred to at a given constant pool
881 * index.
882 *
883 * The result is in UTF format and remains valid until JVM_ReleaseUTF
884 * is called.
885 *
886 * The caller must treat the string as a constant and not modify it
887 * in any way.
888 */
889 JNIEXPORT const char * JNICALL
890 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
891
892 /*
893 * Returns the class name referred to at a given constant pool index.
894 *
895 * The result is in UTF format and remains valid until JVM_ReleaseUTF
896 * is called.
897 *
898 * The caller must treat the string as a constant and not modify it
899 * in any way.
900 */
901 JNIEXPORT const char * JNICALL
902 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
903
904 /*
905 * Returns the class name referred to at a given constant pool index.
906 *
907 * The constant pool entry must refer to a CONSTANT_Fieldref.
908 *
909 * The result is in UTF format and remains valid until JVM_ReleaseUTF
910 * is called.
911 *
912 * The caller must treat the string as a constant and not modify it
913 * in any way.
914 */
915 JNIEXPORT const char * JNICALL
916 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
917
918 /*
919 * Returns the class name referred to at a given constant pool index.
920 *
921 * The constant pool entry must refer to CONSTANT_Methodref or
922 * CONSTANT_InterfaceMethodref.
923 *
924 * The result is in UTF format and remains valid until JVM_ReleaseUTF
925 * is called.
926 *
927 * The caller must treat the string as a constant and not modify it
928 * in any way.
929 */
930 JNIEXPORT const char * JNICALL
931 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
932
933 /*
934 * Returns the modifiers of a field in calledClass. The field is
935 * referred to in class cb at constant pool entry index.
936 *
937 * The caller must treat the string as a constant and not modify it
938 * in any way.
939 *
940 * Returns -1 if the field does not exist in calledClass.
941 */
942 JNIEXPORT jint JNICALL
943 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
944
945 /*
946 * Returns the modifiers of a method in calledClass. The method is
947 * referred to in class cb at constant pool entry index.
948 *
949 * Returns -1 if the method does not exist in calledClass.
950 */
951 JNIEXPORT jint JNICALL
952 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
953
954 /*
955 * Releases the UTF string obtained from the VM.
956 */
957 JNIEXPORT void JNICALL
958 JVM_ReleaseUTF(const char *utf);
959
960 /*
961 * Compare if two classes are in the same package.
962 */
963 JNIEXPORT jboolean JNICALL
964 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
965
966 /* Get classfile constants */
967 #include "classfile_constants.h"
968
969 /*
970 * A function defined by the byte-code verifier and called by the VM.
971 * This is not a function implemented in the VM.
972 *
973 * Returns JNI_FALSE if verification fails. A detailed error message
974 * will be places in msg_buf, whose length is specified by buf_len.
975 */
976 typedef jboolean (*verifier_fn_t)(JNIEnv *env,
977 jclass cb,
978 char * msg_buf,
979 jint buf_len);
980
981
982 /*
983 * Support for a VM-independent class format checker.
984 */
985 typedef struct {
986 unsigned long code; /* byte code */
987 unsigned long excs; /* exceptions */
988 unsigned long etab; /* catch table */
989 unsigned long lnum; /* line number */
990 unsigned long lvar; /* local vars */
991 } method_size_info;
992
993 typedef struct {
994 unsigned int constants; /* constant pool */
995 unsigned int fields;
996 unsigned int methods;
997 unsigned int interfaces;
998 unsigned int fields2; /* number of static 2-word fields */
999 unsigned int innerclasses; /* # of records in InnerClasses attr */
1000
1001 method_size_info clinit; /* memory used in clinit */
1002 method_size_info main; /* used everywhere else */
1003 } class_size_info;
1004
1005 /*
1006 * Functions defined in libjava.so to perform string conversions.
1007 *
1008 */
1009
1010 typedef jstring (*to_java_string_fn_t)(JNIEnv *env, char *str);
1011
1012 typedef char *(*to_c_string_fn_t)(JNIEnv *env, jstring s, jboolean *b);
1013
1014 /* This is the function defined in libjava.so that performs class
1015 * format checks. This functions fills in size information about
1016 * the class file and returns:
1017 *
1018 * 0: good
1019 * -1: out of memory
1020 * -2: bad format
1021 * -3: unsupported version
1022 * -4: bad class name
1023 */
1024
1025 typedef jint (*check_format_fn_t)(char *class_name,
1026 unsigned char *data,
1027 unsigned int data_size,
1028 class_size_info *class_size,
1029 char *message_buffer,
1030 jint buffer_length,
1031 jboolean measure_only,
1032 jboolean check_relaxed);
1033
1034 #define JVM_RECOGNIZED_CLASS_MODIFIERS (JVM_ACC_PUBLIC | \
1035 JVM_ACC_FINAL | \
1036 JVM_ACC_SUPER | \
1037 JVM_ACC_INTERFACE | \
1038 JVM_ACC_ABSTRACT | \
1039 JVM_ACC_ANNOTATION | \
1040 JVM_ACC_ENUM | \
1041 JVM_ACC_SYNTHETIC)
1042
1043 #define JVM_RECOGNIZED_FIELD_MODIFIERS (JVM_ACC_PUBLIC | \
1044 JVM_ACC_PRIVATE | \
1045 JVM_ACC_PROTECTED | \
1046 JVM_ACC_STATIC | \
1047 JVM_ACC_FINAL | \
1048 JVM_ACC_VOLATILE | \
1049 JVM_ACC_TRANSIENT | \
1050 JVM_ACC_ENUM | \
1051 JVM_ACC_SYNTHETIC)
1052
1053 #define JVM_RECOGNIZED_METHOD_MODIFIERS (JVM_ACC_PUBLIC | \
1054 JVM_ACC_PRIVATE | \
1055 JVM_ACC_PROTECTED | \
1056 JVM_ACC_STATIC | \
1057 JVM_ACC_FINAL | \
1058 JVM_ACC_SYNCHRONIZED | \
1059 JVM_ACC_BRIDGE | \
1060 JVM_ACC_VARARGS | \
1061 JVM_ACC_NATIVE | \
1062 JVM_ACC_ABSTRACT | \
1063 JVM_ACC_STRICT | \
1064 JVM_ACC_SYNTHETIC)
1065
1066 /*
1067 * This is the function defined in libjava.so to perform path
1068 * canonicalization. VM call this function before opening jar files
1069 * to load system classes.
1070 *
1071 */
1072
1073 typedef int (*canonicalize_fn_t)(JNIEnv *env, char *orig, char *out, int len);
1074
1075 /*************************************************************************
1076 PART 3: I/O and Network Support
1077 ************************************************************************/
1078
1079 /*
1080 * Convert a pathname into native format. This function does syntactic
1081 * cleanup, such as removing redundant separator characters. It modifies
1082 * the given pathname string in place.
1083 */
1084 JNIEXPORT char * JNICALL
1085 JVM_NativePath(char *);
1086
1087 /*
1088 * The standard printing functions supported by the Java VM. (Should they
1089 * be renamed to JVM_* in the future?
1090 */
1091
1092 /*
1093 * BE CAREFUL! The following functions do not implement the
1094 * full feature set of standard C printf formats.
1095 */
1096 int
1097 jio_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1098
1099 int
1100 jio_snprintf(char *str, size_t count, const char *fmt, ...);
1101
1102 int
1103 jio_fprintf(FILE *, const char *fmt, ...);
1104
1105 int
1106 jio_vfprintf(FILE *, const char *fmt, va_list args);
1107
1108
1109 JNIEXPORT void * JNICALL
1110 JVM_RawMonitorCreate(void);
1111
1112 JNIEXPORT void JNICALL
1113 JVM_RawMonitorDestroy(void *mon);
1114
1115 JNIEXPORT jint JNICALL
1116 JVM_RawMonitorEnter(void *mon);
1117
1118 JNIEXPORT void JNICALL
1119 JVM_RawMonitorExit(void *mon);
1120
1121 /*
1122 * java.lang.management support
1123 */
1124 JNIEXPORT void* JNICALL
1125 JVM_GetManagement(jint version);
1126
1127 /*
1128 * com.sun.tools.attach.VirtualMachine support
1129 *
1130 * Initialize the agent properties with the properties maintained in the VM.
1131 */
1132 JNIEXPORT jobject JNICALL
1133 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
1134
1135 JNIEXPORT jstring JNICALL
1136 JVM_GetTemporaryDirectory(JNIEnv *env);
1137
1138 /* Generics reflection support.
1139 *
1140 * Returns information about the given class's EnclosingMethod
1141 * attribute, if present, or null if the class had no enclosing
1142 * method.
1143 *
1144 * If non-null, the returned array contains three elements. Element 0
1145 * is the java.lang.Class of which the enclosing method is a member,
1146 * and elements 1 and 2 are the java.lang.Strings for the enclosing
1147 * method's name and descriptor, respectively.
1148 */
1149 JNIEXPORT jobjectArray JNICALL
1150 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
1151
1152 /* =========================================================================
1153 * The following defines a private JVM interface that the JDK can query
1154 * for the JVM version and capabilities. sun.misc.Version defines
1155 * the methods for getting the VM version and its capabilities.
1156 *
1157 * When a new bit is added, the following should be updated to provide
1158 * access to the new capability:
1159 * HS: JVM_GetVersionInfo and Abstract_VM_Version class
1160 * SDK: Version class
1161 *
1162 * Similary, a private JDK interface JDK_GetVersionInfo0 is defined for
1163 * JVM to query for the JDK version and capabilities.
1164 *
1165 * When a new bit is added, the following should be updated to provide
1166 * access to the new capability:
1167 * HS: JDK_Version class
1168 * SDK: JDK_GetVersionInfo0
1169 *
1170 * ==========================================================================
1171 */
1172 typedef struct {
1173 /* Naming convention of RE build version string: n.n.n[_uu[c]][-<identifier>]-bxx */
1174 unsigned int jvm_version; /* Consists of major, minor, micro (n.n.n) */
1175 /* and build number (xx) */
1176 unsigned int update_version : 8; /* Update release version (uu) */
1177 unsigned int special_update_version : 8; /* Special update release version (c)*/
1178 unsigned int reserved1 : 16;
1179 unsigned int reserved2;
1180
1181 /* The following bits represents JVM supports that JDK has dependency on.
1182 * JDK can use these bits to determine which JVM version
1183 * and support it has to maintain runtime compatibility.
1184 *
1185 * When a new bit is added in a minor or update release, make sure
1186 * the new bit is also added in the main/baseline.
1187 */
1188 unsigned int is_attach_supported : 1;
1189 unsigned int : 31;
1190 unsigned int : 32;
1191 unsigned int : 32;
1192 } jvm_version_info;
1193
1194 #define JVM_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1195 #define JVM_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1196 #define JVM_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
1197
1198 /* Build number is available only for RE builds.
1199 * It will be zero for internal builds.
1200 */
1201 #define JVM_VERSION_BUILD(version) ((version & 0x000000FF))
1202
1203 JNIEXPORT void JNICALL
1204 JVM_GetVersionInfo(JNIEnv* env, jvm_version_info* info, size_t info_size);
1205
1206 typedef struct {
1207 // Naming convention of RE build version string: n.n.n[_uu[c]][-<identifier>]-bxx
1208 unsigned int jdk_version; /* Consists of major, minor, micro (n.n.n) */
1209 /* and build number (xx) */
1210 unsigned int update_version : 8; /* Update release version (uu) */
1211 unsigned int special_update_version : 8; /* Special update release version (c)*/
1212 unsigned int reserved1 : 16;
1213 unsigned int reserved2;
1214
1215 /* The following bits represents new JDK supports that VM has dependency on.
1216 * VM implementation can use these bits to determine which JDK version
1217 * and support it has to maintain runtime compatibility.
1218 *
1219 * When a new bit is added in a minor or update release, make sure
1220 * the new bit is also added in the main/baseline.
1221 */
1222 unsigned int thread_park_blocker : 1;
1223 unsigned int post_vm_init_hook_enabled : 1;
1224 unsigned int pending_list_uses_discovered_field : 1;
1225 unsigned int : 29;
1226 unsigned int : 32;
1227 unsigned int : 32;
1228 } jdk_version_info;
1229
1230 #define JDK_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1231 #define JDK_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1232 #define JDK_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
1233
1234 /* Build number is available only for RE build (i.e. JDK_BUILD_NUMBER is set to bNN)
1235 * It will be zero for internal builds.
1236 */
1237 #define JDK_VERSION_BUILD(version) ((version & 0x000000FF))
1238
1239 /*
1240 * This is the function JDK_GetVersionInfo0 defined in libjava.so
1241 * that is dynamically looked up by JVM.
1242 */
1243 typedef void (*jdk_version_info_fn_t)(jdk_version_info* info, size_t info_size);
1244
1245 /*
1246 * This structure is used by the launcher to get the default thread
1247 * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1248 * version of 1.1. As it is not supported otherwise, it has been removed
1249 * from jni.h
1250 */
1251 typedef struct JDK1_1InitArgs {
1252 jint version;
1253
1254 char **properties;
1255 jint checkSource;
1256 jint nativeStackSize;
1257 jint javaStackSize;
1258 jint minHeapSize;
1259 jint maxHeapSize;
1260 jint verifyMode;
1261 char *classpath;
1262
1263 jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1264 void (JNICALL *exit)(jint code);
1265 void (JNICALL *abort)(void);
1266
1267 jint enableClassGC;
1268 jint enableVerboseGC;
1269 jint disableAsyncGC;
1270 jint verbose;
1271 jboolean debugging;
1272 jint debugPort;
1273 } JDK1_1InitArgs;
1274
1275
1276 #ifdef __cplusplus
1277 } /* extern "C" */
1278
1279 #endif /* __cplusplus */
1280
1281 #endif /* !_JAVASOFT_JVM_H_ */