src/share/vm/prims/jvm.h

Thu, 20 Dec 2012 10:22:19 +0100

author
stefank
date
Thu, 20 Dec 2012 10:22:19 +0100
changeset 4393
35431a769282
parent 4037
da91efe96a93
child 4398
ade95d680b42
permissions
-rw-r--r--

8004823: Add VM support for type annotation reflection
Reviewed-by: dholmes, coleenp
Contributed-by: joel.franck@oracle.com

     1 /*
     2  * Copyright (c) 1997, 2012, 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.
     8  *
     9  * This code is distributed in the hope that it will be useful, but WITHOUT
    10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    12  * version 2 for more details (a copy is included in the LICENSE file that
    13  * accompanied this code).
    14  *
    15  * You should have received a copy of the GNU General Public License version
    16  * 2 along with this work; if not, write to the Free Software Foundation,
    17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    18  *
    19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    20  * or visit www.oracle.com if you need additional information or have any
    21  * questions.
    22  *
    23  */
    25 #ifndef SHARE_VM_PRIMS_JVM_H
    26 #define SHARE_VM_PRIMS_JVM_H
    28 #include "prims/jni.h"
    29 #ifdef TARGET_OS_FAMILY_linux
    30 # include "jvm_linux.h"
    31 #endif
    32 #ifdef TARGET_OS_FAMILY_solaris
    33 # include "jvm_solaris.h"
    34 #endif
    35 #ifdef TARGET_OS_FAMILY_windows
    36 # include "jvm_windows.h"
    37 #endif
    38 #ifdef TARGET_OS_FAMILY_bsd
    39 # include "jvm_bsd.h"
    40 #endif
    42 #ifndef _JAVASOFT_JVM_H_
    43 #define _JAVASOFT_JVM_H_
    45 // HotSpot integration note:
    46 //
    47 // This file and jvm.h used with the JDK are identical,
    48 // except for the three includes removed below
    50 // #include <sys/stat.h>
    51 // #include "jni.h"
    52 // #include "jvm_md.h"
    55 #ifdef __cplusplus
    56 extern "C" {
    57 #endif
    59 /*
    60  * This file contains additional functions exported from the VM.
    61  * These functions are complementary to the standard JNI support.
    62  * There are three parts to this file:
    63  *
    64  * First, this file contains the VM-related functions needed by native
    65  * libraries in the standard Java API. For example, the java.lang.Object
    66  * class needs VM-level functions that wait for and notify monitors.
    67  *
    68  * Second, this file contains the functions and constant definitions
    69  * needed by the byte code verifier and class file format checker.
    70  * These functions allow the verifier and format checker to be written
    71  * in a VM-independent way.
    72  *
    73  * Third, this file contains various I/O and nerwork operations needed
    74  * by the standard Java I/O and network APIs.
    75  */
    77 /*
    78  * Bump the version number when either of the following happens:
    79  *
    80  * 1. There is a change in JVM_* functions.
    81  *
    82  * 2. There is a change in the contract between VM and Java classes.
    83  *    For example, if the VM relies on a new private field in Thread
    84  *    class.
    85  */
    87 #define JVM_INTERFACE_VERSION 4
    90 JNIEXPORT jint JNICALL
    91 JVM_GetInterfaceVersion(void);
    93 /*************************************************************************
    94  PART 1: Functions for Native Libraries
    95  ************************************************************************/
    96 /*
    97  * java.lang.Object
    98  */
    99 JNIEXPORT jint JNICALL
   100 JVM_IHashCode(JNIEnv *env, jobject obj);
   102 JNIEXPORT void JNICALL
   103 JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);
   105 JNIEXPORT void JNICALL
   106 JVM_MonitorNotify(JNIEnv *env, jobject obj);
   108 JNIEXPORT void JNICALL
   109 JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);
   111 JNIEXPORT jobject JNICALL
   112 JVM_Clone(JNIEnv *env, jobject obj);
   114 /*
   115  * java.lang.String
   116  */
   117 JNIEXPORT jstring JNICALL
   118 JVM_InternString(JNIEnv *env, jstring str);
   120 /*
   121  * java.lang.System
   122  */
   123 JNIEXPORT jlong JNICALL
   124 JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);
   126 JNIEXPORT jlong JNICALL
   127 JVM_NanoTime(JNIEnv *env, jclass ignored);
   129 JNIEXPORT void JNICALL
   130 JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,
   131               jobject dst, jint dst_pos, jint length);
   133 JNIEXPORT jobject JNICALL
   134 JVM_InitProperties(JNIEnv *env, jobject p);
   136 /*
   137  * java.io.File
   138  */
   139 JNIEXPORT void JNICALL
   140 JVM_OnExit(void (*func)(void));
   142 /*
   143  * java.lang.Runtime
   144  */
   145 JNIEXPORT void JNICALL
   146 JVM_Exit(jint code);
   148 JNIEXPORT void JNICALL
   149 JVM_Halt(jint code);
   151 JNIEXPORT void JNICALL
   152 JVM_GC(void);
   154 /* Returns the number of real-time milliseconds that have elapsed since the
   155  * least-recently-inspected heap object was last inspected by the garbage
   156  * collector.
   157  *
   158  * For simple stop-the-world collectors this value is just the time
   159  * since the most recent collection.  For generational collectors it is the
   160  * time since the oldest generation was most recently collected.  Other
   161  * collectors are free to return a pessimistic estimate of the elapsed time, or
   162  * simply the time since the last full collection was performed.
   163  *
   164  * Note that in the presence of reference objects, a given object that is no
   165  * longer strongly reachable may have to be inspected multiple times before it
   166  * can be reclaimed.
   167  */
   168 JNIEXPORT jlong JNICALL
   169 JVM_MaxObjectInspectionAge(void);
   171 JNIEXPORT void JNICALL
   172 JVM_TraceInstructions(jboolean on);
   174 JNIEXPORT void JNICALL
   175 JVM_TraceMethodCalls(jboolean on);
   177 JNIEXPORT jlong JNICALL
   178 JVM_TotalMemory(void);
   180 JNIEXPORT jlong JNICALL
   181 JVM_FreeMemory(void);
   183 JNIEXPORT jlong JNICALL
   184 JVM_MaxMemory(void);
   186 JNIEXPORT jint JNICALL
   187 JVM_ActiveProcessorCount(void);
   189 JNIEXPORT void * JNICALL
   190 JVM_LoadLibrary(const char *name);
   192 JNIEXPORT void JNICALL
   193 JVM_UnloadLibrary(void * handle);
   195 JNIEXPORT void * JNICALL
   196 JVM_FindLibraryEntry(void *handle, const char *name);
   198 JNIEXPORT jboolean JNICALL
   199 JVM_IsSupportedJNIVersion(jint version);
   201 /*
   202  * java.lang.Float and java.lang.Double
   203  */
   204 JNIEXPORT jboolean JNICALL
   205 JVM_IsNaN(jdouble d);
   207 /*
   208  * java.lang.Throwable
   209  */
   210 JNIEXPORT void JNICALL
   211 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
   213 JNIEXPORT void JNICALL
   214 JVM_PrintStackTrace(JNIEnv *env, jobject throwable, jobject printable);
   216 JNIEXPORT jint JNICALL
   217 JVM_GetStackTraceDepth(JNIEnv *env, jobject throwable);
   219 JNIEXPORT jobject JNICALL
   220 JVM_GetStackTraceElement(JNIEnv *env, jobject throwable, jint index);
   222 /*
   223  * java.lang.Compiler
   224  */
   225 JNIEXPORT void JNICALL
   226 JVM_InitializeCompiler (JNIEnv *env, jclass compCls);
   228 JNIEXPORT jboolean JNICALL
   229 JVM_IsSilentCompiler(JNIEnv *env, jclass compCls);
   231 JNIEXPORT jboolean JNICALL
   232 JVM_CompileClass(JNIEnv *env, jclass compCls, jclass cls);
   234 JNIEXPORT jboolean JNICALL
   235 JVM_CompileClasses(JNIEnv *env, jclass cls, jstring jname);
   237 JNIEXPORT jobject JNICALL
   238 JVM_CompilerCommand(JNIEnv *env, jclass compCls, jobject arg);
   240 JNIEXPORT void JNICALL
   241 JVM_EnableCompiler(JNIEnv *env, jclass compCls);
   243 JNIEXPORT void JNICALL
   244 JVM_DisableCompiler(JNIEnv *env, jclass compCls);
   246 /*
   247  * java.lang.Thread
   248  */
   249 JNIEXPORT void JNICALL
   250 JVM_StartThread(JNIEnv *env, jobject thread);
   252 JNIEXPORT void JNICALL
   253 JVM_StopThread(JNIEnv *env, jobject thread, jobject exception);
   255 JNIEXPORT jboolean JNICALL
   256 JVM_IsThreadAlive(JNIEnv *env, jobject thread);
   258 JNIEXPORT void JNICALL
   259 JVM_SuspendThread(JNIEnv *env, jobject thread);
   261 JNIEXPORT void JNICALL
   262 JVM_ResumeThread(JNIEnv *env, jobject thread);
   264 JNIEXPORT void JNICALL
   265 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
   267 JNIEXPORT void JNICALL
   268 JVM_Yield(JNIEnv *env, jclass threadClass);
   270 JNIEXPORT void JNICALL
   271 JVM_Sleep(JNIEnv *env, jclass threadClass, jlong millis);
   273 JNIEXPORT jobject JNICALL
   274 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
   276 JNIEXPORT jint JNICALL
   277 JVM_CountStackFrames(JNIEnv *env, jobject thread);
   279 JNIEXPORT void JNICALL
   280 JVM_Interrupt(JNIEnv *env, jobject thread);
   282 JNIEXPORT jboolean JNICALL
   283 JVM_IsInterrupted(JNIEnv *env, jobject thread, jboolean clearInterrupted);
   285 JNIEXPORT jboolean JNICALL
   286 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
   288 JNIEXPORT void JNICALL
   289 JVM_DumpAllStacks(JNIEnv *env, jclass unused);
   291 JNIEXPORT jobjectArray JNICALL
   292 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
   294 JNIEXPORT void JNICALL
   295 JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);
   297 /* getStackTrace() and getAllStackTraces() method */
   298 JNIEXPORT jobjectArray JNICALL
   299 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
   301 /*
   302  * java.lang.SecurityManager
   303  */
   304 JNIEXPORT jclass JNICALL
   305 JVM_CurrentLoadedClass(JNIEnv *env);
   307 JNIEXPORT jobject JNICALL
   308 JVM_CurrentClassLoader(JNIEnv *env);
   310 JNIEXPORT jobjectArray JNICALL
   311 JVM_GetClassContext(JNIEnv *env);
   313 JNIEXPORT jint JNICALL
   314 JVM_ClassDepth(JNIEnv *env, jstring name);
   316 JNIEXPORT jint JNICALL
   317 JVM_ClassLoaderDepth(JNIEnv *env);
   319 /*
   320  * java.lang.Package
   321  */
   322 JNIEXPORT jstring JNICALL
   323 JVM_GetSystemPackage(JNIEnv *env, jstring name);
   325 JNIEXPORT jobjectArray JNICALL
   326 JVM_GetSystemPackages(JNIEnv *env);
   328 /*
   329  * java.io.ObjectInputStream
   330  */
   331 JNIEXPORT jobject JNICALL
   332 JVM_AllocateNewObject(JNIEnv *env, jobject obj, jclass currClass,
   333                       jclass initClass);
   335 JNIEXPORT jobject JNICALL
   336 JVM_AllocateNewArray(JNIEnv *env, jobject obj, jclass currClass,
   337                      jint length);
   339 JNIEXPORT jobject JNICALL
   340 JVM_LatestUserDefinedLoader(JNIEnv *env);
   342 /*
   343  * This function has been deprecated and should not be considered
   344  * part of the specified JVM interface.
   345  */
   346 JNIEXPORT jclass JNICALL
   347 JVM_LoadClass0(JNIEnv *env, jobject obj, jclass currClass,
   348                jstring currClassName);
   350 /*
   351  * java.lang.reflect.Array
   352  */
   353 JNIEXPORT jint JNICALL
   354 JVM_GetArrayLength(JNIEnv *env, jobject arr);
   356 JNIEXPORT jobject JNICALL
   357 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
   359 JNIEXPORT jvalue JNICALL
   360 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
   362 JNIEXPORT void JNICALL
   363 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
   365 JNIEXPORT void JNICALL
   366 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
   367                              unsigned char vCode);
   369 JNIEXPORT jobject JNICALL
   370 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
   372 JNIEXPORT jobject JNICALL
   373 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
   375 /*
   376  * java.lang.Class and java.lang.ClassLoader
   377  */
   378 /*
   379  * Returns the class in which the code invoking the native method
   380  * belongs.
   381  *
   382  * Note that in JDK 1.1, native methods did not create a frame.
   383  * In 1.2, they do. Therefore native methods like Class.forName
   384  * can no longer look at the current frame for the caller class.
   385  */
   386 JNIEXPORT jclass JNICALL
   387 JVM_GetCallerClass(JNIEnv *env, int n);
   389 /*
   390  * Find primitive classes
   391  * utf: class name
   392  */
   393 JNIEXPORT jclass JNICALL
   394 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
   396 /*
   397  * Link the class
   398  */
   399 JNIEXPORT void JNICALL
   400 JVM_ResolveClass(JNIEnv *env, jclass cls);
   402 /*
   403  * Find a class from a given class loader. Throw ClassNotFoundException
   404  * or NoClassDefFoundError depending on the value of the last
   405  * argument.
   406  */
   407 JNIEXPORT jclass JNICALL
   408 JVM_FindClassFromClassLoader(JNIEnv *env, const char *name, jboolean init,
   409                              jobject loader, jboolean throwError);
   411 /*
   412  * Find a class from a boot class loader. Returns NULL if class not found.
   413  */
   414 JNIEXPORT jclass JNICALL
   415 JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);
   417 /*
   418  * Find a class from a given class.
   419  */
   420 JNIEXPORT jclass JNICALL
   421 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
   422                              jclass from);
   424 /* Find a loaded class cached by the VM */
   425 JNIEXPORT jclass JNICALL
   426 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
   428 /* Define a class */
   429 JNIEXPORT jclass JNICALL
   430 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
   431                 jsize len, jobject pd);
   433 /* Define a class with a source (added in JDK1.5) */
   434 JNIEXPORT jclass JNICALL
   435 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
   436                           const jbyte *buf, jsize len, jobject pd,
   437                           const char *source);
   439 /* Define a class with a source with conditional verification (added HSX 14)
   440  * -Xverify:all will verify anyway, -Xverify:none will not verify,
   441  * -Xverify:remote (default) will obey this conditional
   442  * i.e. true = should_verify_class
   443  */
   444 JNIEXPORT jclass JNICALL
   445 JVM_DefineClassWithSourceCond(JNIEnv *env, const char *name,
   446                               jobject loader, const jbyte *buf,
   447                               jsize len, jobject pd, const char *source,
   448                               jboolean verify);
   450 /*
   451  * Reflection support functions
   452  */
   454 JNIEXPORT jstring JNICALL
   455 JVM_GetClassName(JNIEnv *env, jclass cls);
   457 JNIEXPORT jobjectArray JNICALL
   458 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
   460 JNIEXPORT jobject JNICALL
   461 JVM_GetClassLoader(JNIEnv *env, jclass cls);
   463 JNIEXPORT jboolean JNICALL
   464 JVM_IsInterface(JNIEnv *env, jclass cls);
   466 JNIEXPORT jobjectArray JNICALL
   467 JVM_GetClassSigners(JNIEnv *env, jclass cls);
   469 JNIEXPORT void JNICALL
   470 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
   472 JNIEXPORT jobject JNICALL
   473 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
   475 JNIEXPORT void JNICALL
   476 JVM_SetProtectionDomain(JNIEnv *env, jclass cls, jobject protection_domain);
   478 JNIEXPORT jboolean JNICALL
   479 JVM_IsArrayClass(JNIEnv *env, jclass cls);
   481 JNIEXPORT jboolean JNICALL
   482 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
   484 JNIEXPORT jclass JNICALL
   485 JVM_GetComponentType(JNIEnv *env, jclass cls);
   487 JNIEXPORT jint JNICALL
   488 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
   490 JNIEXPORT jobjectArray JNICALL
   491 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
   493 JNIEXPORT jclass JNICALL
   494 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
   496 /* Generics support (JDK 1.5) */
   497 JNIEXPORT jstring JNICALL
   498 JVM_GetClassSignature(JNIEnv *env, jclass cls);
   500 /* Annotations support (JDK 1.5) */
   501 JNIEXPORT jbyteArray JNICALL
   502 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
   504 /* Annotations support (JDK 1.6) */
   506 // field is a handle to a java.lang.reflect.Field object
   507 JNIEXPORT jbyteArray JNICALL
   508 JVM_GetFieldAnnotations(JNIEnv *env, jobject field);
   510 // method is a handle to a java.lang.reflect.Method object
   511 JNIEXPORT jbyteArray JNICALL
   512 JVM_GetMethodAnnotations(JNIEnv *env, jobject method);
   514 // method is a handle to a java.lang.reflect.Method object
   515 JNIEXPORT jbyteArray JNICALL
   516 JVM_GetMethodDefaultAnnotationValue(JNIEnv *env, jobject method);
   518 // method is a handle to a java.lang.reflect.Method object
   519 JNIEXPORT jbyteArray JNICALL
   520 JVM_GetMethodParameterAnnotations(JNIEnv *env, jobject method);
   522 /* Type use annotations support (JDK 1.8) */
   524 JNIEXPORT jbyteArray JNICALL
   525 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
   527 /*
   528  * New (JDK 1.4) reflection implementation
   529  */
   531 JNIEXPORT jobjectArray JNICALL
   532 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
   534 JNIEXPORT jobjectArray JNICALL
   535 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
   537 JNIEXPORT jobjectArray JNICALL
   538 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
   540 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
   541    This returns the access flags for the class as specified in the
   542    class file rather than searching the InnerClasses attribute (if
   543    present) to find the source-level access flags. Only the values of
   544    the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
   545    valid. */
   546 JNIEXPORT jint JNICALL
   547 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
   549 /*
   550  * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
   551  */
   553 JNIEXPORT jobject JNICALL
   554 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
   556 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
   557 (JNIEnv *env, jobject obj, jobject unused);
   559 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
   560 (JNIEnv *env, jobject obj, jobject unused, jint index);
   562 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
   563 (JNIEnv *env, jobject obj, jobject unused, jint index);
   565 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
   566 (JNIEnv *env, jobject obj, jobject unused, jint index);
   568 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
   569 (JNIEnv *env, jobject obj, jobject unused, jint index);
   571 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
   572 (JNIEnv *env, jobject obj, jobject unused, jint index);
   574 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
   575 (JNIEnv *env, jobject obj, jobject unused, jint index);
   577 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
   578 (JNIEnv *env, jobject obj, jobject unused, jint index);
   580 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
   581 (JNIEnv *env, jobject obj, jobject unused, jint index);
   583 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
   584 (JNIEnv *env, jobject obj, jobject unused, jint index);
   586 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
   587 (JNIEnv *env, jobject obj, jobject unused, jint index);
   589 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
   590 (JNIEnv *env, jobject obj, jobject unused, jint index);
   592 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
   593 (JNIEnv *env, jobject obj, jobject unused, jint index);
   595 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
   596 (JNIEnv *env, jobject obj, jobject unused, jint index);
   598 /*
   599  * java.security.*
   600  */
   602 JNIEXPORT jobject JNICALL
   603 JVM_DoPrivileged(JNIEnv *env, jclass cls,
   604                  jobject action, jobject context, jboolean wrapException);
   606 JNIEXPORT jobject JNICALL
   607 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
   609 JNIEXPORT jobject JNICALL
   610 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
   612 /*
   613  * Signal support, used to implement the shutdown sequence.  Every VM must
   614  * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
   615  * (^C) and the latter for external termination (kill, system shutdown, etc.).
   616  * Other platform-dependent signal values may also be supported.
   617  */
   619 JNIEXPORT void * JNICALL
   620 JVM_RegisterSignal(jint sig, void *handler);
   622 JNIEXPORT jboolean JNICALL
   623 JVM_RaiseSignal(jint sig);
   625 JNIEXPORT jint JNICALL
   626 JVM_FindSignal(const char *name);
   628 /*
   629  * Retrieve the assertion directives for the specified class.
   630  */
   631 JNIEXPORT jboolean JNICALL
   632 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
   634 /*
   635  * Retrieve the assertion directives from the VM.
   636  */
   637 JNIEXPORT jobject JNICALL
   638 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
   640 /*
   641  * java.util.concurrent.atomic.AtomicLong
   642  */
   643 JNIEXPORT jboolean JNICALL
   644 JVM_SupportsCX8(void);
   646 JNIEXPORT jboolean JNICALL
   647 JVM_CX8Field(JNIEnv *env, jobject obj, jfieldID fldID, jlong oldVal, jlong newVal);
   649 /*
   650  * com.sun.dtrace.jsdt support
   651  */
   653 #define JVM_TRACING_DTRACE_VERSION 1
   655 /*
   656  * Structure to pass one probe description to JVM.
   657  *
   658  * The VM will overwrite the definition of the referenced method with
   659  * code that will fire the probe.
   660  */
   661 typedef struct {
   662     jmethodID method;
   663     jstring   function;
   664     jstring   name;
   665     void*     reserved[4];     // for future use
   666 } JVM_DTraceProbe;
   668 /**
   669  * Encapsulates the stability ratings for a DTrace provider field
   670  */
   671 typedef struct {
   672     jint nameStability;
   673     jint dataStability;
   674     jint dependencyClass;
   675 } JVM_DTraceInterfaceAttributes;
   677 /*
   678  * Structure to pass one provider description to JVM
   679  */
   680 typedef struct {
   681     jstring                       name;
   682     JVM_DTraceProbe*              probes;
   683     jint                          probe_count;
   684     JVM_DTraceInterfaceAttributes providerAttributes;
   685     JVM_DTraceInterfaceAttributes moduleAttributes;
   686     JVM_DTraceInterfaceAttributes functionAttributes;
   687     JVM_DTraceInterfaceAttributes nameAttributes;
   688     JVM_DTraceInterfaceAttributes argsAttributes;
   689     void*                         reserved[4]; // for future use
   690 } JVM_DTraceProvider;
   692 /*
   693  * Get the version number the JVM was built with
   694  */
   695 JNIEXPORT jint JNICALL
   696 JVM_DTraceGetVersion(JNIEnv* env);
   698 /*
   699  * Register new probe with given signature, return global handle
   700  *
   701  * The version passed in is the version that the library code was
   702  * built with.
   703  */
   704 JNIEXPORT jlong JNICALL
   705 JVM_DTraceActivate(JNIEnv* env, jint version, jstring module_name,
   706   jint providers_count, JVM_DTraceProvider* providers);
   708 /*
   709  * Check JSDT probe
   710  */
   711 JNIEXPORT jboolean JNICALL
   712 JVM_DTraceIsProbeEnabled(JNIEnv* env, jmethodID method);
   714 /*
   715  * Destroy custom DOF
   716  */
   717 JNIEXPORT void JNICALL
   718 JVM_DTraceDispose(JNIEnv* env, jlong handle);
   720 /*
   721  * Check to see if DTrace is supported by OS
   722  */
   723 JNIEXPORT jboolean JNICALL
   724 JVM_DTraceIsSupported(JNIEnv* env);
   726 /*************************************************************************
   727  PART 2: Support for the Verifier and Class File Format Checker
   728  ************************************************************************/
   729 /*
   730  * Return the class name in UTF format. The result is valid
   731  * until JVM_ReleaseUTf is called.
   732  *
   733  * The caller must treat the string as a constant and not modify it
   734  * in any way.
   735  */
   736 JNIEXPORT const char * JNICALL
   737 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
   739 /*
   740  * Returns the constant pool types in the buffer provided by "types."
   741  */
   742 JNIEXPORT void JNICALL
   743 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
   745 /*
   746  * Returns the number of Constant Pool entries.
   747  */
   748 JNIEXPORT jint JNICALL
   749 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
   751 /*
   752  * Returns the number of *declared* fields or methods.
   753  */
   754 JNIEXPORT jint JNICALL
   755 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
   757 JNIEXPORT jint JNICALL
   758 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
   760 /*
   761  * Returns the CP indexes of exceptions raised by a given method.
   762  * Places the result in the given buffer.
   763  *
   764  * The method is identified by method_index.
   765  */
   766 JNIEXPORT void JNICALL
   767 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
   768                                 unsigned short *exceptions);
   769 /*
   770  * Returns the number of exceptions raised by a given method.
   771  * The method is identified by method_index.
   772  */
   773 JNIEXPORT jint JNICALL
   774 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
   776 /*
   777  * Returns the byte code sequence of a given method.
   778  * Places the result in the given buffer.
   779  *
   780  * The method is identified by method_index.
   781  */
   782 JNIEXPORT void JNICALL
   783 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
   784                         unsigned char *code);
   786 /*
   787  * Returns the length of the byte code sequence of a given method.
   788  * The method is identified by method_index.
   789  */
   790 JNIEXPORT jint JNICALL
   791 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
   793 /*
   794  * A structure used to a capture exception table entry in a Java method.
   795  */
   796 typedef struct {
   797     jint start_pc;
   798     jint end_pc;
   799     jint handler_pc;
   800     jint catchType;
   801 } JVM_ExceptionTableEntryType;
   803 /*
   804  * Returns the exception table entry at entry_index of a given method.
   805  * Places the result in the given buffer.
   806  *
   807  * The method is identified by method_index.
   808  */
   809 JNIEXPORT void JNICALL
   810 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
   811                                    jint entry_index,
   812                                    JVM_ExceptionTableEntryType *entry);
   814 /*
   815  * Returns the length of the exception table of a given method.
   816  * The method is identified by method_index.
   817  */
   818 JNIEXPORT jint JNICALL
   819 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
   821 /*
   822  * Returns the modifiers of a given field.
   823  * The field is identified by field_index.
   824  */
   825 JNIEXPORT jint JNICALL
   826 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
   828 /*
   829  * Returns the modifiers of a given method.
   830  * The method is identified by method_index.
   831  */
   832 JNIEXPORT jint JNICALL
   833 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
   835 /*
   836  * Returns the number of local variables of a given method.
   837  * The method is identified by method_index.
   838  */
   839 JNIEXPORT jint JNICALL
   840 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
   842 /*
   843  * Returns the number of arguments (including this pointer) of a given method.
   844  * The method is identified by method_index.
   845  */
   846 JNIEXPORT jint JNICALL
   847 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
   849 /*
   850  * Returns the maximum amount of stack (in words) used by a given method.
   851  * The method is identified by method_index.
   852  */
   853 JNIEXPORT jint JNICALL
   854 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
   856 /*
   857  * Is a given method a constructor.
   858  * The method is identified by method_index.
   859  */
   860 JNIEXPORT jboolean JNICALL
   861 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
   863 /*
   864  * Returns the name of a given method in UTF format.
   865  * The result remains valid until JVM_ReleaseUTF is called.
   866  *
   867  * The caller must treat the string as a constant and not modify it
   868  * in any way.
   869  */
   870 JNIEXPORT const char * JNICALL
   871 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
   873 /*
   874  * Returns the signature of a given method in UTF format.
   875  * The result remains valid until JVM_ReleaseUTF is called.
   876  *
   877  * The caller must treat the string as a constant and not modify it
   878  * in any way.
   879  */
   880 JNIEXPORT const char * JNICALL
   881 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
   883 /*
   884  * Returns the name of the field refered to at a given constant pool
   885  * index.
   886  *
   887  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   888  * is called.
   889  *
   890  * The caller must treat the string as a constant and not modify it
   891  * in any way.
   892  */
   893 JNIEXPORT const char * JNICALL
   894 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
   896 /*
   897  * Returns the name of the method refered to at a given constant pool
   898  * index.
   899  *
   900  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   901  * is called.
   902  *
   903  * The caller must treat the string as a constant and not modify it
   904  * in any way.
   905  */
   906 JNIEXPORT const char * JNICALL
   907 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
   909 /*
   910  * Returns the signature of the method refered to at a given constant pool
   911  * index.
   912  *
   913  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   914  * is called.
   915  *
   916  * The caller must treat the string as a constant and not modify it
   917  * in any way.
   918  */
   919 JNIEXPORT const char * JNICALL
   920 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
   922 /*
   923  * Returns the signature of the field refered to at a given constant pool
   924  * index.
   925  *
   926  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   927  * is called.
   928  *
   929  * The caller must treat the string as a constant and not modify it
   930  * in any way.
   931  */
   932 JNIEXPORT const char * JNICALL
   933 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
   935 /*
   936  * Returns the class name refered to at a given constant pool index.
   937  *
   938  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   939  * is called.
   940  *
   941  * The caller must treat the string as a constant and not modify it
   942  * in any way.
   943  */
   944 JNIEXPORT const char * JNICALL
   945 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
   947 /*
   948  * Returns the class name refered to at a given constant pool index.
   949  *
   950  * The constant pool entry must refer to a CONSTANT_Fieldref.
   951  *
   952  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   953  * is called.
   954  *
   955  * The caller must treat the string as a constant and not modify it
   956  * in any way.
   957  */
   958 JNIEXPORT const char * JNICALL
   959 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
   961 /*
   962  * Returns the class name refered to at a given constant pool index.
   963  *
   964  * The constant pool entry must refer to CONSTANT_Methodref or
   965  * CONSTANT_InterfaceMethodref.
   966  *
   967  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   968  * is called.
   969  *
   970  * The caller must treat the string as a constant and not modify it
   971  * in any way.
   972  */
   973 JNIEXPORT const char * JNICALL
   974 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
   976 /*
   977  * Returns the modifiers of a field in calledClass. The field is
   978  * referred to in class cb at constant pool entry index.
   979  *
   980  * The caller must treat the string as a constant and not modify it
   981  * in any way.
   982  *
   983  * Returns -1 if the field does not exist in calledClass.
   984  */
   985 JNIEXPORT jint JNICALL
   986 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
   988 /*
   989  * Returns the modifiers of a method in calledClass. The method is
   990  * referred to in class cb at constant pool entry index.
   991  *
   992  * Returns -1 if the method does not exist in calledClass.
   993  */
   994 JNIEXPORT jint JNICALL
   995 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
   997 /*
   998  * Releases the UTF string obtained from the VM.
   999  */
  1000 JNIEXPORT void JNICALL
  1001 JVM_ReleaseUTF(const char *utf);
  1003 /*
  1004  * Compare if two classes are in the same package.
  1005  */
  1006 JNIEXPORT jboolean JNICALL
  1007 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
  1009 /* Constants in class files */
  1011 #define JVM_ACC_PUBLIC        0x0001  /* visible to everyone */
  1012 #define JVM_ACC_PRIVATE       0x0002  /* visible only to the defining class */
  1013 #define JVM_ACC_PROTECTED     0x0004  /* visible to subclasses */
  1014 #define JVM_ACC_STATIC        0x0008  /* instance variable is static */
  1015 #define JVM_ACC_FINAL         0x0010  /* no further subclassing, overriding */
  1016 #define JVM_ACC_SYNCHRONIZED  0x0020  /* wrap method call in monitor lock */
  1017 #define JVM_ACC_SUPER         0x0020  /* funky handling of invokespecial */
  1018 #define JVM_ACC_VOLATILE      0x0040  /* can not cache in registers */
  1019 #define JVM_ACC_BRIDGE        0x0040  /* bridge method generated by compiler */
  1020 #define JVM_ACC_TRANSIENT     0x0080  /* not persistent */
  1021 #define JVM_ACC_VARARGS       0x0080  /* method declared with variable number of args */
  1022 #define JVM_ACC_NATIVE        0x0100  /* implemented in C */
  1023 #define JVM_ACC_INTERFACE     0x0200  /* class is an interface */
  1024 #define JVM_ACC_ABSTRACT      0x0400  /* no definition provided */
  1025 #define JVM_ACC_STRICT        0x0800  /* strict floating point */
  1026 #define JVM_ACC_SYNTHETIC     0x1000  /* compiler-generated class, method or field */
  1027 #define JVM_ACC_ANNOTATION    0x2000  /* annotation type */
  1028 #define JVM_ACC_ENUM          0x4000  /* field is declared as element of enum */
  1030 #define JVM_ACC_PUBLIC_BIT        0
  1031 #define JVM_ACC_PRIVATE_BIT       1
  1032 #define JVM_ACC_PROTECTED_BIT     2
  1033 #define JVM_ACC_STATIC_BIT        3
  1034 #define JVM_ACC_FINAL_BIT         4
  1035 #define JVM_ACC_SYNCHRONIZED_BIT  5
  1036 #define JVM_ACC_SUPER_BIT         5
  1037 #define JVM_ACC_VOLATILE_BIT      6
  1038 #define JVM_ACC_BRIDGE_BIT        6
  1039 #define JVM_ACC_TRANSIENT_BIT     7
  1040 #define JVM_ACC_VARARGS_BIT       7
  1041 #define JVM_ACC_NATIVE_BIT        8
  1042 #define JVM_ACC_INTERFACE_BIT     9
  1043 #define JVM_ACC_ABSTRACT_BIT      10
  1044 #define JVM_ACC_STRICT_BIT        11
  1045 #define JVM_ACC_SYNTHETIC_BIT     12
  1046 #define JVM_ACC_ANNOTATION_BIT    13
  1047 #define JVM_ACC_ENUM_BIT          14
  1049 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/utilities/ConstantTag.java
  1050 enum {
  1051     JVM_CONSTANT_Utf8 = 1,
  1052     JVM_CONSTANT_Unicode,               /* unused */
  1053     JVM_CONSTANT_Integer,
  1054     JVM_CONSTANT_Float,
  1055     JVM_CONSTANT_Long,
  1056     JVM_CONSTANT_Double,
  1057     JVM_CONSTANT_Class,
  1058     JVM_CONSTANT_String,
  1059     JVM_CONSTANT_Fieldref,
  1060     JVM_CONSTANT_Methodref,
  1061     JVM_CONSTANT_InterfaceMethodref,
  1062     JVM_CONSTANT_NameAndType,
  1063     JVM_CONSTANT_MethodHandle           = 15,  // JSR 292
  1064     JVM_CONSTANT_MethodType             = 16,  // JSR 292
  1065     //JVM_CONSTANT_(unused)             = 17,  // JSR 292 early drafts only
  1066     JVM_CONSTANT_InvokeDynamic          = 18,  // JSR 292
  1067     JVM_CONSTANT_ExternalMax            = 18   // Last tag found in classfiles
  1068 };
  1070 /* JVM_CONSTANT_MethodHandle subtypes */
  1071 enum {
  1072     JVM_REF_getField                = 1,
  1073     JVM_REF_getStatic               = 2,
  1074     JVM_REF_putField                = 3,
  1075     JVM_REF_putStatic               = 4,
  1076     JVM_REF_invokeVirtual           = 5,
  1077     JVM_REF_invokeStatic            = 6,
  1078     JVM_REF_invokeSpecial           = 7,
  1079     JVM_REF_newInvokeSpecial        = 8,
  1080     JVM_REF_invokeInterface         = 9
  1081 };
  1083 /* Used in the newarray instruction. */
  1085 #define JVM_T_BOOLEAN 4
  1086 #define JVM_T_CHAR    5
  1087 #define JVM_T_FLOAT   6
  1088 #define JVM_T_DOUBLE  7
  1089 #define JVM_T_BYTE    8
  1090 #define JVM_T_SHORT   9
  1091 #define JVM_T_INT    10
  1092 #define JVM_T_LONG   11
  1094 /* JVM method signatures */
  1096 #define JVM_SIGNATURE_ARRAY             '['
  1097 #define JVM_SIGNATURE_BYTE              'B'
  1098 #define JVM_SIGNATURE_CHAR              'C'
  1099 #define JVM_SIGNATURE_CLASS             'L'
  1100 #define JVM_SIGNATURE_ENDCLASS          ';'
  1101 #define JVM_SIGNATURE_ENUM              'E'
  1102 #define JVM_SIGNATURE_FLOAT             'F'
  1103 #define JVM_SIGNATURE_DOUBLE            'D'
  1104 #define JVM_SIGNATURE_FUNC              '('
  1105 #define JVM_SIGNATURE_ENDFUNC           ')'
  1106 #define JVM_SIGNATURE_INT               'I'
  1107 #define JVM_SIGNATURE_LONG              'J'
  1108 #define JVM_SIGNATURE_SHORT             'S'
  1109 #define JVM_SIGNATURE_VOID              'V'
  1110 #define JVM_SIGNATURE_BOOLEAN           'Z'
  1112 /*
  1113  * A function defined by the byte-code verifier and called by the VM.
  1114  * This is not a function implemented in the VM.
  1116  * Returns JNI_FALSE if verification fails. A detailed error message
  1117  * will be places in msg_buf, whose length is specified by buf_len.
  1118  */
  1119 typedef jboolean (*verifier_fn_t)(JNIEnv *env,
  1120                                   jclass cb,
  1121                                   char * msg_buf,
  1122                                   jint buf_len);
  1125 /*
  1126  * Support for a VM-independent class format checker.
  1127  */
  1128 typedef struct {
  1129     unsigned long code;    /* byte code */
  1130     unsigned long excs;    /* exceptions */
  1131     unsigned long etab;    /* catch table */
  1132     unsigned long lnum;    /* line number */
  1133     unsigned long lvar;    /* local vars */
  1134 } method_size_info;
  1136 typedef struct {
  1137     unsigned int constants;    /* constant pool */
  1138     unsigned int fields;
  1139     unsigned int methods;
  1140     unsigned int interfaces;
  1141     unsigned int fields2;      /* number of static 2-word fields */
  1142     unsigned int innerclasses; /* # of records in InnerClasses attr */
  1144     method_size_info clinit;   /* memory used in clinit */
  1145     method_size_info main;     /* used everywhere else */
  1146 } class_size_info;
  1148 /*
  1149  * Functions defined in libjava.so to perform string conversions.
  1151  */
  1153 typedef jstring (*to_java_string_fn_t)(JNIEnv *env, char *str);
  1155 typedef char *(*to_c_string_fn_t)(JNIEnv *env, jstring s, jboolean *b);
  1157 /* This is the function defined in libjava.so that performs class
  1158  * format checks. This functions fills in size information about
  1159  * the class file and returns:
  1161  *   0: good
  1162  *  -1: out of memory
  1163  *  -2: bad format
  1164  *  -3: unsupported version
  1165  *  -4: bad class name
  1166  */
  1168 typedef jint (*check_format_fn_t)(char *class_name,
  1169                                   unsigned char *data,
  1170                                   unsigned int data_size,
  1171                                   class_size_info *class_size,
  1172                                   char *message_buffer,
  1173                                   jint buffer_length,
  1174                                   jboolean measure_only,
  1175                                   jboolean check_relaxed);
  1177 #define JVM_RECOGNIZED_CLASS_MODIFIERS (JVM_ACC_PUBLIC | \
  1178                                         JVM_ACC_FINAL | \
  1179                                         JVM_ACC_SUPER | \
  1180                                         JVM_ACC_INTERFACE | \
  1181                                         JVM_ACC_ABSTRACT | \
  1182                                         JVM_ACC_ANNOTATION | \
  1183                                         JVM_ACC_ENUM | \
  1184                                         JVM_ACC_SYNTHETIC)
  1186 #define JVM_RECOGNIZED_FIELD_MODIFIERS (JVM_ACC_PUBLIC | \
  1187                                         JVM_ACC_PRIVATE | \
  1188                                         JVM_ACC_PROTECTED | \
  1189                                         JVM_ACC_STATIC | \
  1190                                         JVM_ACC_FINAL | \
  1191                                         JVM_ACC_VOLATILE | \
  1192                                         JVM_ACC_TRANSIENT | \
  1193                                         JVM_ACC_ENUM | \
  1194                                         JVM_ACC_SYNTHETIC)
  1196 #define JVM_RECOGNIZED_METHOD_MODIFIERS (JVM_ACC_PUBLIC | \
  1197                                          JVM_ACC_PRIVATE | \
  1198                                          JVM_ACC_PROTECTED | \
  1199                                          JVM_ACC_STATIC | \
  1200                                          JVM_ACC_FINAL | \
  1201                                          JVM_ACC_SYNCHRONIZED | \
  1202                                          JVM_ACC_BRIDGE | \
  1203                                          JVM_ACC_VARARGS | \
  1204                                          JVM_ACC_NATIVE | \
  1205                                          JVM_ACC_ABSTRACT | \
  1206                                          JVM_ACC_STRICT | \
  1207                                          JVM_ACC_SYNTHETIC)
  1209 /*
  1210  * This is the function defined in libjava.so to perform path
  1211  * canonicalization. VM call this function before opening jar files
  1212  * to load system classes.
  1214  */
  1216 typedef int (*canonicalize_fn_t)(JNIEnv *env, char *orig, char *out, int len);
  1218 /*************************************************************************
  1219  PART 3: I/O and Network Support
  1220  ************************************************************************/
  1222 /* Note that the JVM IO functions are expected to return JVM_IO_ERR
  1223  * when there is any kind of error. The caller can then use the
  1224  * platform specific support (e.g., errno) to get the detailed
  1225  * error info.  The JVM_GetLastErrorString procedure may also be used
  1226  * to obtain a descriptive error string.
  1227  */
  1228 #define JVM_IO_ERR  (-1)
  1230 /* For interruptible IO. Returning JVM_IO_INTR indicates that an IO
  1231  * operation has been disrupted by Thread.interrupt. There are a
  1232  * number of technical difficulties related to interruptible IO that
  1233  * need to be solved. For example, most existing programs do not handle
  1234  * InterruptedIOExceptions specially, they simply treat those as any
  1235  * IOExceptions, which typically indicate fatal errors.
  1237  * There are also two modes of operation for interruptible IO. In the
  1238  * resumption mode, an interrupted IO operation is guaranteed not to
  1239  * have any side-effects, and can be restarted. In the termination mode,
  1240  * an interrupted IO operation corrupts the underlying IO stream, so
  1241  * that the only reasonable operation on an interrupted stream is to
  1242  * close that stream. The resumption mode seems to be impossible to
  1243  * implement on Win32 and Solaris. Implementing the termination mode is
  1244  * easier, but it's not clear that's the right semantics.
  1246  * Interruptible IO is not supported on Win32.It can be enabled/disabled
  1247  * using a compile-time flag on Solaris. Third-party JVM ports do not
  1248  * need to implement interruptible IO.
  1249  */
  1250 #define JVM_IO_INTR (-2)
  1252 /* Write a string into the given buffer, in the platform's local encoding,
  1253  * that describes the most recent system-level error to occur in this thread.
  1254  * Return the length of the string or zero if no error occurred.
  1255  */
  1256 JNIEXPORT jint JNICALL
  1257 JVM_GetLastErrorString(char *buf, int len);
  1259 /*
  1260  * Convert a pathname into native format.  This function does syntactic
  1261  * cleanup, such as removing redundant separator characters.  It modifies
  1262  * the given pathname string in place.
  1263  */
  1264 JNIEXPORT char * JNICALL
  1265 JVM_NativePath(char *);
  1267 /*
  1268  * JVM I/O error codes
  1269  */
  1270 #define JVM_EEXIST       -100
  1272 /*
  1273  * Open a file descriptor. This function returns a negative error code
  1274  * on error, and a non-negative integer that is the file descriptor on
  1275  * success.
  1276  */
  1277 JNIEXPORT jint JNICALL
  1278 JVM_Open(const char *fname, jint flags, jint mode);
  1280 /*
  1281  * Close a file descriptor. This function returns -1 on error, and 0
  1282  * on success.
  1284  * fd        the file descriptor to close.
  1285  */
  1286 JNIEXPORT jint JNICALL
  1287 JVM_Close(jint fd);
  1289 /*
  1290  * Read data from a file decriptor into a char array.
  1292  * fd        the file descriptor to read from.
  1293  * buf       the buffer where to put the read data.
  1294  * nbytes    the number of bytes to read.
  1296  * This function returns -1 on error, and 0 on success.
  1297  */
  1298 JNIEXPORT jint JNICALL
  1299 JVM_Read(jint fd, char *buf, jint nbytes);
  1301 /*
  1302  * Write data from a char array to a file decriptor.
  1304  * fd        the file descriptor to read from.
  1305  * buf       the buffer from which to fetch the data.
  1306  * nbytes    the number of bytes to write.
  1308  * This function returns -1 on error, and 0 on success.
  1309  */
  1310 JNIEXPORT jint JNICALL
  1311 JVM_Write(jint fd, char *buf, jint nbytes);
  1313 /*
  1314  * Returns the number of bytes available for reading from a given file
  1315  * descriptor
  1316  */
  1317 JNIEXPORT jint JNICALL
  1318 JVM_Available(jint fd, jlong *pbytes);
  1320 /*
  1321  * Move the file descriptor pointer from whence by offset.
  1323  * fd        the file descriptor to move.
  1324  * offset    the number of bytes to move it by.
  1325  * whence    the start from where to move it.
  1327  * This function returns the resulting pointer location.
  1328  */
  1329 JNIEXPORT jlong JNICALL
  1330 JVM_Lseek(jint fd, jlong offset, jint whence);
  1332 /*
  1333  * Set the length of the file associated with the given descriptor to the given
  1334  * length.  If the new length is longer than the current length then the file
  1335  * is extended; the contents of the extended portion are not defined.  The
  1336  * value of the file pointer is undefined after this procedure returns.
  1337  */
  1338 JNIEXPORT jint JNICALL
  1339 JVM_SetLength(jint fd, jlong length);
  1341 /*
  1342  * Synchronize the file descriptor's in memory state with that of the
  1343  * physical device.  Return of -1 is an error, 0 is OK.
  1344  */
  1345 JNIEXPORT jint JNICALL
  1346 JVM_Sync(jint fd);
  1348 /*
  1349  * Networking library support
  1350  */
  1352 JNIEXPORT jint JNICALL
  1353 JVM_InitializeSocketLibrary(void);
  1355 struct sockaddr;
  1357 JNIEXPORT jint JNICALL
  1358 JVM_Socket(jint domain, jint type, jint protocol);
  1360 JNIEXPORT jint JNICALL
  1361 JVM_SocketClose(jint fd);
  1363 JNIEXPORT jint JNICALL
  1364 JVM_SocketShutdown(jint fd, jint howto);
  1366 JNIEXPORT jint JNICALL
  1367 JVM_Recv(jint fd, char *buf, jint nBytes, jint flags);
  1369 JNIEXPORT jint JNICALL
  1370 JVM_Send(jint fd, char *buf, jint nBytes, jint flags);
  1372 JNIEXPORT jint JNICALL
  1373 JVM_Timeout(int fd, long timeout);
  1375 JNIEXPORT jint JNICALL
  1376 JVM_Listen(jint fd, jint count);
  1378 JNIEXPORT jint JNICALL
  1379 JVM_Connect(jint fd, struct sockaddr *him, jint len);
  1381 JNIEXPORT jint JNICALL
  1382 JVM_Bind(jint fd, struct sockaddr *him, jint len);
  1384 JNIEXPORT jint JNICALL
  1385 JVM_Accept(jint fd, struct sockaddr *him, jint *len);
  1387 JNIEXPORT jint JNICALL
  1388 JVM_RecvFrom(jint fd, char *buf, int nBytes,
  1389                   int flags, struct sockaddr *from, int *fromlen);
  1391 JNIEXPORT jint JNICALL
  1392 JVM_SendTo(jint fd, char *buf, int len,
  1393                 int flags, struct sockaddr *to, int tolen);
  1395 JNIEXPORT jint JNICALL
  1396 JVM_SocketAvailable(jint fd, jint *result);
  1399 JNIEXPORT jint JNICALL
  1400 JVM_GetSockName(jint fd, struct sockaddr *him, int *len);
  1402 JNIEXPORT jint JNICALL
  1403 JVM_GetSockOpt(jint fd, int level, int optname, char *optval, int *optlen);
  1405 JNIEXPORT jint JNICALL
  1406 JVM_SetSockOpt(jint fd, int level, int optname, const char *optval, int optlen);
  1408 JNIEXPORT int JNICALL
  1409 JVM_GetHostName(char* name, int namelen);
  1411 /*
  1412  * The standard printing functions supported by the Java VM. (Should they
  1413  * be renamed to JVM_* in the future?
  1414  */
  1416 /*
  1417  * BE CAREFUL! The following functions do not implement the
  1418  * full feature set of standard C printf formats.
  1419  */
  1420 JNIEXPORT int
  1421 jio_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
  1423 JNIEXPORT int
  1424 jio_snprintf(char *str, size_t count, const char *fmt, ...);
  1426 JNIEXPORT int
  1427 jio_fprintf(FILE *, const char *fmt, ...);
  1429 JNIEXPORT int
  1430 jio_vfprintf(FILE *, const char *fmt, va_list args);
  1433 JNIEXPORT void * JNICALL
  1434 JVM_RawMonitorCreate(void);
  1436 JNIEXPORT void JNICALL
  1437 JVM_RawMonitorDestroy(void *mon);
  1439 JNIEXPORT jint JNICALL
  1440 JVM_RawMonitorEnter(void *mon);
  1442 JNIEXPORT void JNICALL
  1443 JVM_RawMonitorExit(void *mon);
  1445 /*
  1446  * java.lang.reflect.Method
  1447  */
  1448 JNIEXPORT jobject JNICALL
  1449 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
  1451 /*
  1452  * java.lang.reflect.Constructor
  1453  */
  1454 JNIEXPORT jobject JNICALL
  1455 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
  1457 /*
  1458  * java.lang.management support
  1459  */
  1460 JNIEXPORT void* JNICALL
  1461 JVM_GetManagement(jint version);
  1463 /*
  1464  * com.sun.tools.attach.VirtualMachine support
  1466  * Initialize the agent properties with the properties maintained in the VM.
  1467  */
  1468 JNIEXPORT jobject JNICALL
  1469 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
  1471 /* Generics reflection support.
  1473  * Returns information about the given class's EnclosingMethod
  1474  * attribute, if present, or null if the class had no enclosing
  1475  * method.
  1477  * If non-null, the returned array contains three elements. Element 0
  1478  * is the java.lang.Class of which the enclosing method is a member,
  1479  * and elements 1 and 2 are the java.lang.Strings for the enclosing
  1480  * method's name and descriptor, respectively.
  1481  */
  1482 JNIEXPORT jobjectArray JNICALL
  1483 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
  1485 /*
  1486  * Java thread state support
  1487  */
  1488 enum {
  1489     JAVA_THREAD_STATE_NEW           = 0,
  1490     JAVA_THREAD_STATE_RUNNABLE      = 1,
  1491     JAVA_THREAD_STATE_BLOCKED       = 2,
  1492     JAVA_THREAD_STATE_WAITING       = 3,
  1493     JAVA_THREAD_STATE_TIMED_WAITING = 4,
  1494     JAVA_THREAD_STATE_TERMINATED    = 5,
  1495     JAVA_THREAD_STATE_COUNT         = 6
  1496 };
  1498 /*
  1499  * Returns an array of the threadStatus values representing the
  1500  * given Java thread state.  Returns NULL if the VM version is
  1501  * incompatible with the JDK or doesn't support the given
  1502  * Java thread state.
  1503  */
  1504 JNIEXPORT jintArray JNICALL
  1505 JVM_GetThreadStateValues(JNIEnv* env, jint javaThreadState);
  1507 /*
  1508  * Returns an array of the substate names representing the
  1509  * given Java thread state.  Returns NULL if the VM version is
  1510  * incompatible with the JDK or the VM doesn't support
  1511  * the given Java thread state.
  1512  * values must be the jintArray returned from JVM_GetThreadStateValues
  1513  * and javaThreadState.
  1514  */
  1515 JNIEXPORT jobjectArray JNICALL
  1516 JVM_GetThreadStateNames(JNIEnv* env, jint javaThreadState, jintArray values);
  1518 /* =========================================================================
  1519  * The following defines a private JVM interface that the JDK can query
  1520  * for the JVM version and capabilities.  sun.misc.Version defines
  1521  * the methods for getting the VM version and its capabilities.
  1523  * When a new bit is added, the following should be updated to provide
  1524  * access to the new capability:
  1525  *    HS:   JVM_GetVersionInfo and Abstract_VM_Version class
  1526  *    SDK:  Version class
  1528  * Similary, a private JDK interface JDK_GetVersionInfo0 is defined for
  1529  * JVM to query for the JDK version and capabilities.
  1531  * When a new bit is added, the following should be updated to provide
  1532  * access to the new capability:
  1533  *    HS:   JDK_Version class
  1534  *    SDK:  JDK_GetVersionInfo0
  1536  * ==========================================================================
  1537  */
  1538 typedef struct {
  1539     /* HotSpot Express VM version string:
  1540      * <major>.<minor>-bxx[-<identifier>][-<debug_flavor>]
  1541      */
  1542     unsigned int jvm_version; /* Consists of major.minor.0.build */
  1543     unsigned int update_version : 8;         /* 0 in HotSpot Express VM */
  1544     unsigned int special_update_version : 8; /* 0 in HotSpot Express VM */
  1545     unsigned int reserved1 : 16;
  1546     unsigned int reserved2;
  1548     /* The following bits represents JVM supports that JDK has dependency on.
  1549      * JDK can use these bits to determine which JVM version
  1550      * and support it has to maintain runtime compatibility.
  1552      * When a new bit is added in a minor or update release, make sure
  1553      * the new bit is also added in the main/baseline.
  1554      */
  1555     unsigned int is_attachable : 1;
  1556     unsigned int is_kernel_jvm : 1;
  1557     unsigned int : 30;
  1558     unsigned int : 32;
  1559     unsigned int : 32;
  1560 } jvm_version_info;
  1562 #define JVM_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
  1563 #define JVM_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
  1564 // Micro version is 0 in HotSpot Express VM (set in jvm.cpp).
  1565 #define JVM_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
  1566 /* Build number is available in all HotSpot Express VM builds.
  1567  * It is defined in make/hotspot_version file.
  1568  */
  1569 #define JVM_VERSION_BUILD(version) ((version & 0x000000FF))
  1571 JNIEXPORT void JNICALL
  1572 JVM_GetVersionInfo(JNIEnv* env, jvm_version_info* info, size_t info_size);
  1574 typedef struct {
  1575     // Naming convention of RE build version string: n.n.n[_uu[c]][-<identifier>]-bxx
  1576     unsigned int jdk_version;   /* Consists of major, minor, micro (n.n.n) */
  1577                                 /* and build number (xx) */
  1578     unsigned int update_version : 8;         /* Update release version (uu) */
  1579     unsigned int special_update_version : 8; /* Special update release version (c)*/
  1580     unsigned int reserved1 : 16;
  1581     unsigned int reserved2;
  1583     /* The following bits represents new JDK supports that VM has dependency on.
  1584      * VM implementation can use these bits to determine which JDK version
  1585      * and support it has to maintain runtime compatibility.
  1587      * When a new bit is added in a minor or update release, make sure
  1588      * the new bit is also added in the main/baseline.
  1589      */
  1590     unsigned int thread_park_blocker : 1;
  1591     unsigned int post_vm_init_hook_enabled : 1;
  1592     unsigned int pending_list_uses_discovered_field : 1;
  1593     unsigned int : 29;
  1594     unsigned int : 32;
  1595     unsigned int : 32;
  1596 } jdk_version_info;
  1598 #define JDK_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
  1599 #define JDK_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
  1600 #define JDK_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
  1602 /* Build number is available only for RE build (i.e. JDK_BUILD_NUMBER is set to bNN)
  1603  * It will be zero for internal builds.
  1604  */
  1605 #define JDK_VERSION_BUILD(version) ((version & 0x000000FF))
  1607 /*
  1608  * This is the function JDK_GetVersionInfo0 defined in libjava.so
  1609  * that is dynamically looked up by JVM.
  1610  */
  1611 typedef void (*jdk_version_info_fn_t)(jdk_version_info* info, size_t info_size);
  1613 /*
  1614  * This structure is used by the launcher to get the default thread
  1615  * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
  1616  * version of 1.1.  As it is not supported otherwise, it has been removed
  1617  * from jni.h
  1618  */
  1619 typedef struct JDK1_1InitArgs {
  1620     jint version;
  1622     char **properties;
  1623     jint checkSource;
  1624     jint nativeStackSize;
  1625     jint javaStackSize;
  1626     jint minHeapSize;
  1627     jint maxHeapSize;
  1628     jint verifyMode;
  1629     char *classpath;
  1631     jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
  1632     void (JNICALL *exit)(jint code);
  1633     void (JNICALL *abort)(void);
  1635     jint enableClassGC;
  1636     jint enableVerboseGC;
  1637     jint disableAsyncGC;
  1638     jint verbose;
  1639     jboolean debugging;
  1640     jint debugPort;
  1641 } JDK1_1InitArgs;
  1643 #ifdef __cplusplus
  1644 } /* extern "C" */
  1645 #endif /* __cplusplus */
  1647 #endif /* !_JAVASOFT_JVM_H_ */
  1649 #endif // SHARE_VM_PRIMS_JVM_H

mercurial