src/share/vm/prims/jvm.h

Wed, 02 Jul 2008 12:55:16 -0700

author
xdono
date
Wed, 02 Jul 2008 12:55:16 -0700
changeset 631
d1605aabd0a1
parent 551
018d5b58dd4f
child 670
9c2ecc2ffb12
permissions
-rw-r--r--

6719955: Update copyright year
Summary: Update copyright year for files that have been modified in 2008
Reviewed-by: ohair, tbell

     1 /*
     2  * Copyright 1997-2008 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    20  * CA 95054 USA or visit www.sun.com if you need additional information or
    21  * have any questions.
    22  *
    23  */
    25 #ifndef _JAVASOFT_JVM_H_
    26 #define _JAVASOFT_JVM_H_
    28 // HotSpot integration note:
    29 //
    30 // This file and jvm.h used with the JDK are identical,
    31 // except for the three includes removed below and the
    32 // SUPPORT_OLD_REFLECTION sections cut out of the JDK's jvm.h.
    34 // #include <sys/stat.h>
    35 // #include "jni.h"
    36 // #include "jvm_md.h"
    39 #ifdef __cplusplus
    40 extern "C" {
    41 #endif
    43 /*
    44  * This file contains additional functions exported from the VM.
    45  * These functions are complementary to the standard JNI support.
    46  * There are three parts to this file:
    47  *
    48  * First, this file contains the VM-related functions needed by native
    49  * libraries in the standard Java API. For example, the java.lang.Object
    50  * class needs VM-level functions that wait for and notify monitors.
    51  *
    52  * Second, this file contains the functions and constant definitions
    53  * needed by the byte code verifier and class file format checker.
    54  * These functions allow the verifier and format checker to be written
    55  * in a VM-independent way.
    56  *
    57  * Third, this file contains various I/O and nerwork operations needed
    58  * by the standard Java I/O and network APIs.
    59  */
    61 /*
    62  * Bump the version number when either of the following happens:
    63  *
    64  * 1. There is a change in JVM_* functions.
    65  *
    66  * 2. There is a change in the contract between VM and Java classes.
    67  *    For example, if the VM relies on a new private field in Thread
    68  *    class.
    69  */
    71 #define JVM_INTERFACE_VERSION 4
    74 JNIEXPORT jint JNICALL
    75 JVM_GetInterfaceVersion(void);
    77 /*************************************************************************
    78  PART 1: Functions for Native Libraries
    79  ************************************************************************/
    80 /*
    81  * java.lang.Object
    82  */
    83 JNIEXPORT jint JNICALL
    84 JVM_IHashCode(JNIEnv *env, jobject obj);
    86 JNIEXPORT void JNICALL
    87 JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);
    89 JNIEXPORT void JNICALL
    90 JVM_MonitorNotify(JNIEnv *env, jobject obj);
    92 JNIEXPORT void JNICALL
    93 JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);
    95 JNIEXPORT jobject JNICALL
    96 JVM_Clone(JNIEnv *env, jobject obj);
    98 /*
    99  * java.lang.String
   100  */
   101 JNIEXPORT jstring JNICALL
   102 JVM_InternString(JNIEnv *env, jstring str);
   104 /*
   105  * java.lang.System
   106  */
   107 JNIEXPORT jlong JNICALL
   108 JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);
   110 JNIEXPORT jlong JNICALL
   111 JVM_NanoTime(JNIEnv *env, jclass ignored);
   113 JNIEXPORT void JNICALL
   114 JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,
   115               jobject dst, jint dst_pos, jint length);
   117 JNIEXPORT jobject JNICALL
   118 JVM_InitProperties(JNIEnv *env, jobject p);
   120 /*
   121  * java.io.File
   122  */
   123 JNIEXPORT void JNICALL
   124 JVM_OnExit(void (*func)(void));
   126 /*
   127  * java.lang.Runtime
   128  */
   129 JNIEXPORT void JNICALL
   130 JVM_Exit(jint code);
   132 JNIEXPORT void JNICALL
   133 JVM_Halt(jint code);
   135 JNIEXPORT void JNICALL
   136 JVM_GC(void);
   138 /* Returns the number of real-time milliseconds that have elapsed since the
   139  * least-recently-inspected heap object was last inspected by the garbage
   140  * collector.
   141  *
   142  * For simple stop-the-world collectors this value is just the time
   143  * since the most recent collection.  For generational collectors it is the
   144  * time since the oldest generation was most recently collected.  Other
   145  * collectors are free to return a pessimistic estimate of the elapsed time, or
   146  * simply the time since the last full collection was performed.
   147  *
   148  * Note that in the presence of reference objects, a given object that is no
   149  * longer strongly reachable may have to be inspected multiple times before it
   150  * can be reclaimed.
   151  */
   152 JNIEXPORT jlong JNICALL
   153 JVM_MaxObjectInspectionAge(void);
   155 JNIEXPORT void JNICALL
   156 JVM_TraceInstructions(jboolean on);
   158 JNIEXPORT void JNICALL
   159 JVM_TraceMethodCalls(jboolean on);
   161 JNIEXPORT jlong JNICALL
   162 JVM_TotalMemory(void);
   164 JNIEXPORT jlong JNICALL
   165 JVM_FreeMemory(void);
   167 JNIEXPORT jlong JNICALL
   168 JVM_MaxMemory(void);
   170 JNIEXPORT jint JNICALL
   171 JVM_ActiveProcessorCount(void);
   173 JNIEXPORT void * JNICALL
   174 JVM_LoadLibrary(const char *name);
   176 JNIEXPORT void JNICALL
   177 JVM_UnloadLibrary(void * handle);
   179 JNIEXPORT void * JNICALL
   180 JVM_FindLibraryEntry(void *handle, const char *name);
   182 JNIEXPORT jboolean JNICALL
   183 JVM_IsSupportedJNIVersion(jint version);
   185 /*
   186  * java.lang.Float and java.lang.Double
   187  */
   188 JNIEXPORT jboolean JNICALL
   189 JVM_IsNaN(jdouble d);
   191 /*
   192  * java.lang.Throwable
   193  */
   194 JNIEXPORT void JNICALL
   195 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
   197 JNIEXPORT void JNICALL
   198 JVM_PrintStackTrace(JNIEnv *env, jobject throwable, jobject printable);
   200 JNIEXPORT jint JNICALL
   201 JVM_GetStackTraceDepth(JNIEnv *env, jobject throwable);
   203 JNIEXPORT jobject JNICALL
   204 JVM_GetStackTraceElement(JNIEnv *env, jobject throwable, jint index);
   206 /*
   207  * java.lang.Compiler
   208  */
   209 JNIEXPORT void JNICALL
   210 JVM_InitializeCompiler (JNIEnv *env, jclass compCls);
   212 JNIEXPORT jboolean JNICALL
   213 JVM_IsSilentCompiler(JNIEnv *env, jclass compCls);
   215 JNIEXPORT jboolean JNICALL
   216 JVM_CompileClass(JNIEnv *env, jclass compCls, jclass cls);
   218 JNIEXPORT jboolean JNICALL
   219 JVM_CompileClasses(JNIEnv *env, jclass cls, jstring jname);
   221 JNIEXPORT jobject JNICALL
   222 JVM_CompilerCommand(JNIEnv *env, jclass compCls, jobject arg);
   224 JNIEXPORT void JNICALL
   225 JVM_EnableCompiler(JNIEnv *env, jclass compCls);
   227 JNIEXPORT void JNICALL
   228 JVM_DisableCompiler(JNIEnv *env, jclass compCls);
   230 /*
   231  * java.lang.Thread
   232  */
   233 JNIEXPORT void JNICALL
   234 JVM_StartThread(JNIEnv *env, jobject thread);
   236 JNIEXPORT void JNICALL
   237 JVM_StopThread(JNIEnv *env, jobject thread, jobject exception);
   239 JNIEXPORT jboolean JNICALL
   240 JVM_IsThreadAlive(JNIEnv *env, jobject thread);
   242 JNIEXPORT void JNICALL
   243 JVM_SuspendThread(JNIEnv *env, jobject thread);
   245 JNIEXPORT void JNICALL
   246 JVM_ResumeThread(JNIEnv *env, jobject thread);
   248 JNIEXPORT void JNICALL
   249 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
   251 JNIEXPORT void JNICALL
   252 JVM_Yield(JNIEnv *env, jclass threadClass);
   254 JNIEXPORT void JNICALL
   255 JVM_Sleep(JNIEnv *env, jclass threadClass, jlong millis);
   257 JNIEXPORT jobject JNICALL
   258 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
   260 JNIEXPORT jint JNICALL
   261 JVM_CountStackFrames(JNIEnv *env, jobject thread);
   263 JNIEXPORT void JNICALL
   264 JVM_Interrupt(JNIEnv *env, jobject thread);
   266 JNIEXPORT jboolean JNICALL
   267 JVM_IsInterrupted(JNIEnv *env, jobject thread, jboolean clearInterrupted);
   269 JNIEXPORT jboolean JNICALL
   270 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
   272 JNIEXPORT void JNICALL
   273 JVM_DumpAllStacks(JNIEnv *env, jclass unused);
   275 JNIEXPORT jobjectArray JNICALL
   276 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
   278 /* getStackTrace() and getAllStackTraces() method */
   279 JNIEXPORT jobjectArray JNICALL
   280 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
   282 /*
   283  * java.lang.SecurityManager
   284  */
   285 JNIEXPORT jclass JNICALL
   286 JVM_CurrentLoadedClass(JNIEnv *env);
   288 JNIEXPORT jobject JNICALL
   289 JVM_CurrentClassLoader(JNIEnv *env);
   291 JNIEXPORT jobjectArray JNICALL
   292 JVM_GetClassContext(JNIEnv *env);
   294 JNIEXPORT jint JNICALL
   295 JVM_ClassDepth(JNIEnv *env, jstring name);
   297 JNIEXPORT jint JNICALL
   298 JVM_ClassLoaderDepth(JNIEnv *env);
   300 /*
   301  * java.lang.Package
   302  */
   303 JNIEXPORT jstring JNICALL
   304 JVM_GetSystemPackage(JNIEnv *env, jstring name);
   306 JNIEXPORT jobjectArray JNICALL
   307 JVM_GetSystemPackages(JNIEnv *env);
   309 /*
   310  * java.io.ObjectInputStream
   311  */
   312 JNIEXPORT jobject JNICALL
   313 JVM_AllocateNewObject(JNIEnv *env, jobject obj, jclass currClass,
   314                       jclass initClass);
   316 JNIEXPORT jobject JNICALL
   317 JVM_AllocateNewArray(JNIEnv *env, jobject obj, jclass currClass,
   318                      jint length);
   320 JNIEXPORT jobject JNICALL
   321 JVM_LatestUserDefinedLoader(JNIEnv *env);
   323 /*
   324  * This function has been deprecated and should not be considered
   325  * part of the specified JVM interface.
   326  */
   327 JNIEXPORT jclass JNICALL
   328 JVM_LoadClass0(JNIEnv *env, jobject obj, jclass currClass,
   329                jstring currClassName);
   331 /*
   332  * java.lang.reflect.Array
   333  */
   334 JNIEXPORT jint JNICALL
   335 JVM_GetArrayLength(JNIEnv *env, jobject arr);
   337 JNIEXPORT jobject JNICALL
   338 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
   340 JNIEXPORT jvalue JNICALL
   341 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
   343 JNIEXPORT void JNICALL
   344 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
   346 JNIEXPORT void JNICALL
   347 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
   348                              unsigned char vCode);
   350 JNIEXPORT jobject JNICALL
   351 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
   353 JNIEXPORT jobject JNICALL
   354 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
   356 /*
   357  * java.lang.Class and java.lang.ClassLoader
   358  */
   359 /*
   360  * Returns the class in which the code invoking the native method
   361  * belongs.
   362  *
   363  * Note that in JDK 1.1, native methods did not create a frame.
   364  * In 1.2, they do. Therefore native methods like Class.forName
   365  * can no longer look at the current frame for the caller class.
   366  */
   367 JNIEXPORT jclass JNICALL
   368 JVM_GetCallerClass(JNIEnv *env, int n);
   370 /*
   371  * Find primitive classes
   372  * utf: class name
   373  */
   374 JNIEXPORT jclass JNICALL
   375 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
   377 /*
   378  * Link the class
   379  */
   380 JNIEXPORT void JNICALL
   381 JVM_ResolveClass(JNIEnv *env, jclass cls);
   383 /*
   384  * Find a class from a given class loader. Throw ClassNotFoundException
   385  * or NoClassDefFoundError depending on the value of the last
   386  * argument.
   387  */
   388 JNIEXPORT jclass JNICALL
   389 JVM_FindClassFromClassLoader(JNIEnv *env, const char *name, jboolean init,
   390                              jobject loader, jboolean throwError);
   392 /*
   393  * Find a class from a given class.
   394  */
   395 JNIEXPORT jclass JNICALL
   396 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
   397                              jclass from);
   399 /* Find a loaded class cached by the VM */
   400 JNIEXPORT jclass JNICALL
   401 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
   403 /* Define a class */
   404 JNIEXPORT jclass JNICALL
   405 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
   406                 jsize len, jobject pd);
   408 /* Define a class with a source (added in JDK1.5) */
   409 JNIEXPORT jclass JNICALL
   410 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
   411                           const jbyte *buf, jsize len, jobject pd,
   412                           const char *source);
   414 /*
   415  * Reflection support functions
   416  */
   418 JNIEXPORT jstring JNICALL
   419 JVM_GetClassName(JNIEnv *env, jclass cls);
   421 JNIEXPORT jobjectArray JNICALL
   422 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
   424 JNIEXPORT jobject JNICALL
   425 JVM_GetClassLoader(JNIEnv *env, jclass cls);
   427 JNIEXPORT jboolean JNICALL
   428 JVM_IsInterface(JNIEnv *env, jclass cls);
   430 JNIEXPORT jobjectArray JNICALL
   431 JVM_GetClassSigners(JNIEnv *env, jclass cls);
   433 JNIEXPORT void JNICALL
   434 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
   436 JNIEXPORT jobject JNICALL
   437 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
   439 JNIEXPORT void JNICALL
   440 JVM_SetProtectionDomain(JNIEnv *env, jclass cls, jobject protection_domain);
   442 JNIEXPORT jboolean JNICALL
   443 JVM_IsArrayClass(JNIEnv *env, jclass cls);
   445 JNIEXPORT jboolean JNICALL
   446 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
   448 JNIEXPORT jclass JNICALL
   449 JVM_GetComponentType(JNIEnv *env, jclass cls);
   451 JNIEXPORT jint JNICALL
   452 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
   454 JNIEXPORT jobjectArray JNICALL
   455 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
   457 JNIEXPORT jclass JNICALL
   458 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
   460 /* Generics support (JDK 1.5) */
   461 JNIEXPORT jstring JNICALL
   462 JVM_GetClassSignature(JNIEnv *env, jclass cls);
   464 /* Annotations support (JDK 1.5) */
   465 JNIEXPORT jbyteArray JNICALL
   466 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
   468 /* Annotations support (JDK 1.6) */
   470 // field is a handle to a java.lang.reflect.Field object
   471 JNIEXPORT jbyteArray JNICALL
   472 JVM_GetFieldAnnotations(JNIEnv *env, jobject field);
   474 // method is a handle to a java.lang.reflect.Method object
   475 JNIEXPORT jbyteArray JNICALL
   476 JVM_GetMethodAnnotations(JNIEnv *env, jobject method);
   478 // method is a handle to a java.lang.reflect.Method object
   479 JNIEXPORT jbyteArray JNICALL
   480 JVM_GetMethodDefaultAnnotationValue(JNIEnv *env, jobject method);
   482 // method is a handle to a java.lang.reflect.Method object
   483 JNIEXPORT jbyteArray JNICALL
   484 JVM_GetMethodParameterAnnotations(JNIEnv *env, jobject method);
   487 /*
   488  * New (JDK 1.4) reflection implementation
   489  */
   491 JNIEXPORT jobjectArray JNICALL
   492 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
   494 JNIEXPORT jobjectArray JNICALL
   495 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
   497 JNIEXPORT jobjectArray JNICALL
   498 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
   500 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
   501    This returns the access flags for the class as specified in the
   502    class file rather than searching the InnerClasses attribute (if
   503    present) to find the source-level access flags. Only the values of
   504    the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
   505    valid. */
   506 JNIEXPORT jint JNICALL
   507 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
   509 /*
   510  * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
   511  */
   513 JNIEXPORT jobject JNICALL
   514 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
   516 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
   517 (JNIEnv *env, jobject unused, jobject jcpool);
   519 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
   520 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   522 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
   523 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   525 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
   526 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   528 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
   529 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   531 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
   532 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   534 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
   535 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   537 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
   538 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   540 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
   541 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   543 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
   544 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   546 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
   547 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   549 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
   550 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   552 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
   553 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   555 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
   556 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
   558 /*
   559  * java.security.*
   560  */
   562 JNIEXPORT jobject JNICALL
   563 JVM_DoPrivileged(JNIEnv *env, jclass cls,
   564                  jobject action, jobject context, jboolean wrapException);
   566 JNIEXPORT jobject JNICALL
   567 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
   569 JNIEXPORT jobject JNICALL
   570 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
   572 /*
   573  * Signal support, used to implement the shutdown sequence.  Every VM must
   574  * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
   575  * (^C) and the latter for external termination (kill, system shutdown, etc.).
   576  * Other platform-dependent signal values may also be supported.
   577  */
   579 JNIEXPORT void * JNICALL
   580 JVM_RegisterSignal(jint sig, void *handler);
   582 JNIEXPORT jboolean JNICALL
   583 JVM_RaiseSignal(jint sig);
   585 JNIEXPORT jint JNICALL
   586 JVM_FindSignal(const char *name);
   588 /*
   589  * Retrieve the assertion directives for the specified class.
   590  */
   591 JNIEXPORT jboolean JNICALL
   592 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
   594 /*
   595  * Retrieve the assertion directives from the VM.
   596  */
   597 JNIEXPORT jobject JNICALL
   598 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
   600 /*
   601  * sun.misc.AtomicLong
   602  */
   603 JNIEXPORT jboolean JNICALL
   604 JVM_SupportsCX8(void);
   606 JNIEXPORT jboolean JNICALL
   607 JVM_CX8Field(JNIEnv *env, jobject obj, jfieldID fldID, jlong oldVal, jlong newVal);
   609 /*
   610  * com.sun.dtrace.jsdt support
   611  */
   613 #define JVM_TRACING_DTRACE_VERSION 1
   615 /*
   616  * Structure to pass one probe description to JVM.
   617  *
   618  * The VM will overwrite the definition of the referenced method with
   619  * code that will fire the probe.
   620  */
   621 typedef struct {
   622     jmethodID method;
   623     jstring   function;
   624     jstring   name;
   625     void*     reserved[4];     // for future use
   626 } JVM_DTraceProbe;
   628 /**
   629  * Encapsulates the stability ratings for a DTrace provider field
   630  */
   631 typedef struct {
   632     jint nameStability;
   633     jint dataStability;
   634     jint dependencyClass;
   635 } JVM_DTraceInterfaceAttributes;
   637 /*
   638  * Structure to pass one provider description to JVM
   639  */
   640 typedef struct {
   641     jstring                       name;
   642     JVM_DTraceProbe*              probes;
   643     jint                          probe_count;
   644     JVM_DTraceInterfaceAttributes providerAttributes;
   645     JVM_DTraceInterfaceAttributes moduleAttributes;
   646     JVM_DTraceInterfaceAttributes functionAttributes;
   647     JVM_DTraceInterfaceAttributes nameAttributes;
   648     JVM_DTraceInterfaceAttributes argsAttributes;
   649     void*                         reserved[4]; // for future use
   650 } JVM_DTraceProvider;
   652 /*
   653  * Get the version number the JVM was built with
   654  */
   655 JNIEXPORT jint JNICALL
   656 JVM_DTraceGetVersion(JNIEnv* env);
   658 /*
   659  * Register new probe with given signature, return global handle
   660  *
   661  * The version passed in is the version that the library code was
   662  * built with.
   663  */
   664 JNIEXPORT jlong JNICALL
   665 JVM_DTraceActivate(JNIEnv* env, jint version, jstring module_name,
   666   jint providers_count, JVM_DTraceProvider* providers);
   668 /*
   669  * Check JSDT probe
   670  */
   671 JNIEXPORT jboolean JNICALL
   672 JVM_DTraceIsProbeEnabled(JNIEnv* env, jmethodID method);
   674 /*
   675  * Destroy custom DOF
   676  */
   677 JNIEXPORT void JNICALL
   678 JVM_DTraceDispose(JNIEnv* env, jlong handle);
   680 /*
   681  * Check to see if DTrace is supported by OS
   682  */
   683 JNIEXPORT jboolean JNICALL
   684 JVM_DTraceIsSupported(JNIEnv* env);
   686 /*************************************************************************
   687  PART 2: Support for the Verifier and Class File Format Checker
   688  ************************************************************************/
   689 /*
   690  * Return the class name in UTF format. The result is valid
   691  * until JVM_ReleaseUTf is called.
   692  *
   693  * The caller must treat the string as a constant and not modify it
   694  * in any way.
   695  */
   696 JNIEXPORT const char * JNICALL
   697 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
   699 /*
   700  * Returns the constant pool types in the buffer provided by "types."
   701  */
   702 JNIEXPORT void JNICALL
   703 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
   705 /*
   706  * Returns the number of Constant Pool entries.
   707  */
   708 JNIEXPORT jint JNICALL
   709 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
   711 /*
   712  * Returns the number of *declared* fields or methods.
   713  */
   714 JNIEXPORT jint JNICALL
   715 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
   717 JNIEXPORT jint JNICALL
   718 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
   720 /*
   721  * Returns the CP indexes of exceptions raised by a given method.
   722  * Places the result in the given buffer.
   723  *
   724  * The method is identified by method_index.
   725  */
   726 JNIEXPORT void JNICALL
   727 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
   728                                 unsigned short *exceptions);
   729 /*
   730  * Returns the number of exceptions raised by a given method.
   731  * The method is identified by method_index.
   732  */
   733 JNIEXPORT jint JNICALL
   734 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
   736 /*
   737  * Returns the byte code sequence of a given method.
   738  * Places the result in the given buffer.
   739  *
   740  * The method is identified by method_index.
   741  */
   742 JNIEXPORT void JNICALL
   743 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
   744                         unsigned char *code);
   746 /*
   747  * Returns the length of the byte code sequence of a given method.
   748  * The method is identified by method_index.
   749  */
   750 JNIEXPORT jint JNICALL
   751 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
   753 /*
   754  * A structure used to a capture exception table entry in a Java method.
   755  */
   756 typedef struct {
   757     jint start_pc;
   758     jint end_pc;
   759     jint handler_pc;
   760     jint catchType;
   761 } JVM_ExceptionTableEntryType;
   763 /*
   764  * Returns the exception table entry at entry_index of a given method.
   765  * Places the result in the given buffer.
   766  *
   767  * The method is identified by method_index.
   768  */
   769 JNIEXPORT void JNICALL
   770 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
   771                                    jint entry_index,
   772                                    JVM_ExceptionTableEntryType *entry);
   774 /*
   775  * Returns the length of the exception table of a given method.
   776  * The method is identified by method_index.
   777  */
   778 JNIEXPORT jint JNICALL
   779 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
   781 /*
   782  * Returns the modifiers of a given field.
   783  * The field is identified by field_index.
   784  */
   785 JNIEXPORT jint JNICALL
   786 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
   788 /*
   789  * Returns the modifiers of a given method.
   790  * The method is identified by method_index.
   791  */
   792 JNIEXPORT jint JNICALL
   793 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
   795 /*
   796  * Returns the number of local variables of a given method.
   797  * The method is identified by method_index.
   798  */
   799 JNIEXPORT jint JNICALL
   800 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
   802 /*
   803  * Returns the number of arguments (including this pointer) of a given method.
   804  * The method is identified by method_index.
   805  */
   806 JNIEXPORT jint JNICALL
   807 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
   809 /*
   810  * Returns the maximum amount of stack (in words) used by a given method.
   811  * The method is identified by method_index.
   812  */
   813 JNIEXPORT jint JNICALL
   814 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
   816 /*
   817  * Is a given method a constructor.
   818  * The method is identified by method_index.
   819  */
   820 JNIEXPORT jboolean JNICALL
   821 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
   823 /*
   824  * Returns the name of a given method in UTF format.
   825  * The result remains valid until JVM_ReleaseUTF is called.
   826  *
   827  * The caller must treat the string as a constant and not modify it
   828  * in any way.
   829  */
   830 JNIEXPORT const char * JNICALL
   831 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
   833 /*
   834  * Returns the signature of a given method in UTF format.
   835  * The result remains valid until JVM_ReleaseUTF is called.
   836  *
   837  * The caller must treat the string as a constant and not modify it
   838  * in any way.
   839  */
   840 JNIEXPORT const char * JNICALL
   841 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
   843 /*
   844  * Returns the name of the field refered to at a given constant pool
   845  * index.
   846  *
   847  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   848  * is called.
   849  *
   850  * The caller must treat the string as a constant and not modify it
   851  * in any way.
   852  */
   853 JNIEXPORT const char * JNICALL
   854 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
   856 /*
   857  * Returns the name of the method refered to at a given constant pool
   858  * index.
   859  *
   860  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   861  * is called.
   862  *
   863  * The caller must treat the string as a constant and not modify it
   864  * in any way.
   865  */
   866 JNIEXPORT const char * JNICALL
   867 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
   869 /*
   870  * Returns the signature of the method refered to at a given constant pool
   871  * index.
   872  *
   873  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   874  * is called.
   875  *
   876  * The caller must treat the string as a constant and not modify it
   877  * in any way.
   878  */
   879 JNIEXPORT const char * JNICALL
   880 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
   882 /*
   883  * Returns the signature of the field refered to at a given constant pool
   884  * index.
   885  *
   886  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   887  * is called.
   888  *
   889  * The caller must treat the string as a constant and not modify it
   890  * in any way.
   891  */
   892 JNIEXPORT const char * JNICALL
   893 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
   895 /*
   896  * Returns the class name refered to at a given constant pool index.
   897  *
   898  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   899  * is called.
   900  *
   901  * The caller must treat the string as a constant and not modify it
   902  * in any way.
   903  */
   904 JNIEXPORT const char * JNICALL
   905 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
   907 /*
   908  * Returns the class name refered to at a given constant pool index.
   909  *
   910  * The constant pool entry must refer to a CONSTANT_Fieldref.
   911  *
   912  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   913  * is called.
   914  *
   915  * The caller must treat the string as a constant and not modify it
   916  * in any way.
   917  */
   918 JNIEXPORT const char * JNICALL
   919 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
   921 /*
   922  * Returns the class name refered to at a given constant pool index.
   923  *
   924  * The constant pool entry must refer to CONSTANT_Methodref or
   925  * CONSTANT_InterfaceMethodref.
   926  *
   927  * The result is in UTF format and remains valid until JVM_ReleaseUTF
   928  * is called.
   929  *
   930  * The caller must treat the string as a constant and not modify it
   931  * in any way.
   932  */
   933 JNIEXPORT const char * JNICALL
   934 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
   936 /*
   937  * Returns the modifiers of a field in calledClass. The field is
   938  * referred to in class cb at constant pool entry index.
   939  *
   940  * The caller must treat the string as a constant and not modify it
   941  * in any way.
   942  *
   943  * Returns -1 if the field does not exist in calledClass.
   944  */
   945 JNIEXPORT jint JNICALL
   946 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
   948 /*
   949  * Returns the modifiers of a method in calledClass. The method is
   950  * referred to in class cb at constant pool entry index.
   951  *
   952  * Returns -1 if the method does not exist in calledClass.
   953  */
   954 JNIEXPORT jint JNICALL
   955 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
   957 /*
   958  * Releases the UTF string obtained from the VM.
   959  */
   960 JNIEXPORT void JNICALL
   961 JVM_ReleaseUTF(const char *utf);
   963 /*
   964  * Compare if two classes are in the same package.
   965  */
   966 JNIEXPORT jboolean JNICALL
   967 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
   969 /* Constants in class files */
   971 #define JVM_ACC_PUBLIC        0x0001  /* visible to everyone */
   972 #define JVM_ACC_PRIVATE       0x0002  /* visible only to the defining class */
   973 #define JVM_ACC_PROTECTED     0x0004  /* visible to subclasses */
   974 #define JVM_ACC_STATIC        0x0008  /* instance variable is static */
   975 #define JVM_ACC_FINAL         0x0010  /* no further subclassing, overriding */
   976 #define JVM_ACC_SYNCHRONIZED  0x0020  /* wrap method call in monitor lock */
   977 #define JVM_ACC_SUPER         0x0020  /* funky handling of invokespecial */
   978 #define JVM_ACC_VOLATILE      0x0040  /* can not cache in registers */
   979 #define JVM_ACC_BRIDGE        0x0040  /* bridge method generated by compiler */
   980 #define JVM_ACC_TRANSIENT     0x0080  /* not persistent */
   981 #define JVM_ACC_VARARGS       0x0080  /* method declared with variable number of args */
   982 #define JVM_ACC_NATIVE        0x0100  /* implemented in C */
   983 #define JVM_ACC_INTERFACE     0x0200  /* class is an interface */
   984 #define JVM_ACC_ABSTRACT      0x0400  /* no definition provided */
   985 #define JVM_ACC_STRICT        0x0800  /* strict floating point */
   986 #define JVM_ACC_SYNTHETIC     0x1000  /* compiler-generated class, method or field */
   987 #define JVM_ACC_ANNOTATION    0x2000  /* annotation type */
   988 #define JVM_ACC_ENUM          0x4000  /* field is declared as element of enum */
   990 #define JVM_ACC_PUBLIC_BIT        0
   991 #define JVM_ACC_PRIVATE_BIT       1
   992 #define JVM_ACC_PROTECTED_BIT     2
   993 #define JVM_ACC_STATIC_BIT        3
   994 #define JVM_ACC_FINAL_BIT         4
   995 #define JVM_ACC_SYNCHRONIZED_BIT  5
   996 #define JVM_ACC_SUPER_BIT         5
   997 #define JVM_ACC_VOLATILE_BIT      6
   998 #define JVM_ACC_BRIDGE_BIT        6
   999 #define JVM_ACC_TRANSIENT_BIT     7
  1000 #define JVM_ACC_VARARGS_BIT       7
  1001 #define JVM_ACC_NATIVE_BIT        8
  1002 #define JVM_ACC_INTERFACE_BIT     9
  1003 #define JVM_ACC_ABSTRACT_BIT      10
  1004 #define JVM_ACC_STRICT_BIT        11
  1005 #define JVM_ACC_SYNTHETIC_BIT     12
  1006 #define JVM_ACC_ANNOTATION_BIT    13
  1007 #define JVM_ACC_ENUM_BIT          14
  1009 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/utilities/ConstantTag.java
  1010 enum {
  1011     JVM_CONSTANT_Utf8 = 1,
  1012     JVM_CONSTANT_Unicode,               /* unused */
  1013     JVM_CONSTANT_Integer,
  1014     JVM_CONSTANT_Float,
  1015     JVM_CONSTANT_Long,
  1016     JVM_CONSTANT_Double,
  1017     JVM_CONSTANT_Class,
  1018     JVM_CONSTANT_String,
  1019     JVM_CONSTANT_Fieldref,
  1020     JVM_CONSTANT_Methodref,
  1021     JVM_CONSTANT_InterfaceMethodref,
  1022     JVM_CONSTANT_NameAndType
  1023 };
  1025 /* Used in the newarray instruction. */
  1027 #define JVM_T_BOOLEAN 4
  1028 #define JVM_T_CHAR    5
  1029 #define JVM_T_FLOAT   6
  1030 #define JVM_T_DOUBLE  7
  1031 #define JVM_T_BYTE    8
  1032 #define JVM_T_SHORT   9
  1033 #define JVM_T_INT    10
  1034 #define JVM_T_LONG   11
  1036 /* JVM method signatures */
  1038 #define JVM_SIGNATURE_ARRAY             '['
  1039 #define JVM_SIGNATURE_BYTE              'B'
  1040 #define JVM_SIGNATURE_CHAR              'C'
  1041 #define JVM_SIGNATURE_CLASS             'L'
  1042 #define JVM_SIGNATURE_ENDCLASS          ';'
  1043 #define JVM_SIGNATURE_ENUM              'E'
  1044 #define JVM_SIGNATURE_FLOAT             'F'
  1045 #define JVM_SIGNATURE_DOUBLE            'D'
  1046 #define JVM_SIGNATURE_FUNC              '('
  1047 #define JVM_SIGNATURE_ENDFUNC           ')'
  1048 #define JVM_SIGNATURE_INT               'I'
  1049 #define JVM_SIGNATURE_LONG              'J'
  1050 #define JVM_SIGNATURE_SHORT             'S'
  1051 #define JVM_SIGNATURE_VOID              'V'
  1052 #define JVM_SIGNATURE_BOOLEAN           'Z'
  1054 /*
  1055  * A function defined by the byte-code verifier and called by the VM.
  1056  * This is not a function implemented in the VM.
  1058  * Returns JNI_FALSE if verification fails. A detailed error message
  1059  * will be places in msg_buf, whose length is specified by buf_len.
  1060  */
  1061 typedef jboolean (*verifier_fn_t)(JNIEnv *env,
  1062                                   jclass cb,
  1063                                   char * msg_buf,
  1064                                   jint buf_len);
  1067 /*
  1068  * Support for a VM-independent class format checker.
  1069  */
  1070 typedef struct {
  1071     unsigned long code;    /* byte code */
  1072     unsigned long excs;    /* exceptions */
  1073     unsigned long etab;    /* catch table */
  1074     unsigned long lnum;    /* line number */
  1075     unsigned long lvar;    /* local vars */
  1076 } method_size_info;
  1078 typedef struct {
  1079     unsigned int constants;    /* constant pool */
  1080     unsigned int fields;
  1081     unsigned int methods;
  1082     unsigned int interfaces;
  1083     unsigned int fields2;      /* number of static 2-word fields */
  1084     unsigned int innerclasses; /* # of records in InnerClasses attr */
  1086     method_size_info clinit;   /* memory used in clinit */
  1087     method_size_info main;     /* used everywhere else */
  1088 } class_size_info;
  1090 /*
  1091  * Functions defined in libjava.so to perform string conversions.
  1093  */
  1095 typedef jstring (*to_java_string_fn_t)(JNIEnv *env, char *str);
  1097 typedef char *(*to_c_string_fn_t)(JNIEnv *env, jstring s, jboolean *b);
  1099 /* This is the function defined in libjava.so that performs class
  1100  * format checks. This functions fills in size information about
  1101  * the class file and returns:
  1103  *   0: good
  1104  *  -1: out of memory
  1105  *  -2: bad format
  1106  *  -3: unsupported version
  1107  *  -4: bad class name
  1108  */
  1110 typedef jint (*check_format_fn_t)(char *class_name,
  1111                                   unsigned char *data,
  1112                                   unsigned int data_size,
  1113                                   class_size_info *class_size,
  1114                                   char *message_buffer,
  1115                                   jint buffer_length,
  1116                                   jboolean measure_only,
  1117                                   jboolean check_relaxed);
  1119 #define JVM_RECOGNIZED_CLASS_MODIFIERS (JVM_ACC_PUBLIC | \
  1120                                         JVM_ACC_FINAL | \
  1121                                         JVM_ACC_SUPER | \
  1122                                         JVM_ACC_INTERFACE | \
  1123                                         JVM_ACC_ABSTRACT | \
  1124                                         JVM_ACC_ANNOTATION | \
  1125                                         JVM_ACC_ENUM | \
  1126                                         JVM_ACC_SYNTHETIC)
  1128 #define JVM_RECOGNIZED_FIELD_MODIFIERS (JVM_ACC_PUBLIC | \
  1129                                         JVM_ACC_PRIVATE | \
  1130                                         JVM_ACC_PROTECTED | \
  1131                                         JVM_ACC_STATIC | \
  1132                                         JVM_ACC_FINAL | \
  1133                                         JVM_ACC_VOLATILE | \
  1134                                         JVM_ACC_TRANSIENT | \
  1135                                         JVM_ACC_ENUM | \
  1136                                         JVM_ACC_SYNTHETIC)
  1138 #define JVM_RECOGNIZED_METHOD_MODIFIERS (JVM_ACC_PUBLIC | \
  1139                                          JVM_ACC_PRIVATE | \
  1140                                          JVM_ACC_PROTECTED | \
  1141                                          JVM_ACC_STATIC | \
  1142                                          JVM_ACC_FINAL | \
  1143                                          JVM_ACC_SYNCHRONIZED | \
  1144                                          JVM_ACC_BRIDGE | \
  1145                                          JVM_ACC_VARARGS | \
  1146                                          JVM_ACC_NATIVE | \
  1147                                          JVM_ACC_ABSTRACT | \
  1148                                          JVM_ACC_STRICT | \
  1149                                          JVM_ACC_SYNTHETIC)
  1151 /*
  1152  * This is the function defined in libjava.so to perform path
  1153  * canonicalization. VM call this function before opening jar files
  1154  * to load system classes.
  1156  */
  1158 typedef int (*canonicalize_fn_t)(JNIEnv *env, char *orig, char *out, int len);
  1160 /*************************************************************************
  1161  PART 3: I/O and Network Support
  1162  ************************************************************************/
  1164 /* Note that the JVM IO functions are expected to return JVM_IO_ERR
  1165  * when there is any kind of error. The caller can then use the
  1166  * platform specific support (e.g., errno) to get the detailed
  1167  * error info.  The JVM_GetLastErrorString procedure may also be used
  1168  * to obtain a descriptive error string.
  1169  */
  1170 #define JVM_IO_ERR  (-1)
  1172 /* For interruptible IO. Returning JVM_IO_INTR indicates that an IO
  1173  * operation has been disrupted by Thread.interrupt. There are a
  1174  * number of technical difficulties related to interruptible IO that
  1175  * need to be solved. For example, most existing programs do not handle
  1176  * InterruptedIOExceptions specially, they simply treat those as any
  1177  * IOExceptions, which typically indicate fatal errors.
  1179  * There are also two modes of operation for interruptible IO. In the
  1180  * resumption mode, an interrupted IO operation is guaranteed not to
  1181  * have any side-effects, and can be restarted. In the termination mode,
  1182  * an interrupted IO operation corrupts the underlying IO stream, so
  1183  * that the only reasonable operation on an interrupted stream is to
  1184  * close that stream. The resumption mode seems to be impossible to
  1185  * implement on Win32 and Solaris. Implementing the termination mode is
  1186  * easier, but it's not clear that's the right semantics.
  1188  * Interruptible IO is not supported on Win32.It can be enabled/disabled
  1189  * using a compile-time flag on Solaris. Third-party JVM ports do not
  1190  * need to implement interruptible IO.
  1191  */
  1192 #define JVM_IO_INTR (-2)
  1194 /* Write a string into the given buffer, in the platform's local encoding,
  1195  * that describes the most recent system-level error to occur in this thread.
  1196  * Return the length of the string or zero if no error occurred.
  1197  */
  1198 JNIEXPORT jint JNICALL
  1199 JVM_GetLastErrorString(char *buf, int len);
  1201 /*
  1202  * Convert a pathname into native format.  This function does syntactic
  1203  * cleanup, such as removing redundant separator characters.  It modifies
  1204  * the given pathname string in place.
  1205  */
  1206 JNIEXPORT char * JNICALL
  1207 JVM_NativePath(char *);
  1209 /*
  1210  * JVM I/O error codes
  1211  */
  1212 #define JVM_EEXIST       -100
  1214 /*
  1215  * Open a file descriptor. This function returns a negative error code
  1216  * on error, and a non-negative integer that is the file descriptor on
  1217  * success.
  1218  */
  1219 JNIEXPORT jint JNICALL
  1220 JVM_Open(const char *fname, jint flags, jint mode);
  1222 /*
  1223  * Close a file descriptor. This function returns -1 on error, and 0
  1224  * on success.
  1226  * fd        the file descriptor to close.
  1227  */
  1228 JNIEXPORT jint JNICALL
  1229 JVM_Close(jint fd);
  1231 /*
  1232  * Read data from a file decriptor into a char array.
  1234  * fd        the file descriptor to read from.
  1235  * buf       the buffer where to put the read data.
  1236  * nbytes    the number of bytes to read.
  1238  * This function returns -1 on error, and 0 on success.
  1239  */
  1240 JNIEXPORT jint JNICALL
  1241 JVM_Read(jint fd, char *buf, jint nbytes);
  1243 /*
  1244  * Write data from a char array to a file decriptor.
  1246  * fd        the file descriptor to read from.
  1247  * buf       the buffer from which to fetch the data.
  1248  * nbytes    the number of bytes to write.
  1250  * This function returns -1 on error, and 0 on success.
  1251  */
  1252 JNIEXPORT jint JNICALL
  1253 JVM_Write(jint fd, char *buf, jint nbytes);
  1255 /*
  1256  * Returns the number of bytes available for reading from a given file
  1257  * descriptor
  1258  */
  1259 JNIEXPORT jint JNICALL
  1260 JVM_Available(jint fd, jlong *pbytes);
  1262 /*
  1263  * Move the file descriptor pointer from whence by offset.
  1265  * fd        the file descriptor to move.
  1266  * offset    the number of bytes to move it by.
  1267  * whence    the start from where to move it.
  1269  * This function returns the resulting pointer location.
  1270  */
  1271 JNIEXPORT jlong JNICALL
  1272 JVM_Lseek(jint fd, jlong offset, jint whence);
  1274 /*
  1275  * Set the length of the file associated with the given descriptor to the given
  1276  * length.  If the new length is longer than the current length then the file
  1277  * is extended; the contents of the extended portion are not defined.  The
  1278  * value of the file pointer is undefined after this procedure returns.
  1279  */
  1280 JNIEXPORT jint JNICALL
  1281 JVM_SetLength(jint fd, jlong length);
  1283 /*
  1284  * Synchronize the file descriptor's in memory state with that of the
  1285  * physical device.  Return of -1 is an error, 0 is OK.
  1286  */
  1287 JNIEXPORT jint JNICALL
  1288 JVM_Sync(jint fd);
  1290 /*
  1291  * Networking library support
  1292  */
  1294 JNIEXPORT jint JNICALL
  1295 JVM_InitializeSocketLibrary(void);
  1297 struct sockaddr;
  1299 JNIEXPORT jint JNICALL
  1300 JVM_Socket(jint domain, jint type, jint protocol);
  1302 JNIEXPORT jint JNICALL
  1303 JVM_SocketClose(jint fd);
  1305 JNIEXPORT jint JNICALL
  1306 JVM_SocketShutdown(jint fd, jint howto);
  1308 JNIEXPORT jint JNICALL
  1309 JVM_Recv(jint fd, char *buf, jint nBytes, jint flags);
  1311 JNIEXPORT jint JNICALL
  1312 JVM_Send(jint fd, char *buf, jint nBytes, jint flags);
  1314 JNIEXPORT jint JNICALL
  1315 JVM_Timeout(int fd, long timeout);
  1317 JNIEXPORT jint JNICALL
  1318 JVM_Listen(jint fd, jint count);
  1320 JNIEXPORT jint JNICALL
  1321 JVM_Connect(jint fd, struct sockaddr *him, jint len);
  1323 JNIEXPORT jint JNICALL
  1324 JVM_Bind(jint fd, struct sockaddr *him, jint len);
  1326 JNIEXPORT jint JNICALL
  1327 JVM_Accept(jint fd, struct sockaddr *him, jint *len);
  1329 JNIEXPORT jint JNICALL
  1330 JVM_RecvFrom(jint fd, char *buf, int nBytes,
  1331                   int flags, struct sockaddr *from, int *fromlen);
  1333 JNIEXPORT jint JNICALL
  1334 JVM_SendTo(jint fd, char *buf, int len,
  1335                 int flags, struct sockaddr *to, int tolen);
  1337 JNIEXPORT jint JNICALL
  1338 JVM_SocketAvailable(jint fd, jint *result);
  1341 JNIEXPORT jint JNICALL
  1342 JVM_GetSockName(jint fd, struct sockaddr *him, int *len);
  1344 JNIEXPORT jint JNICALL
  1345 JVM_GetSockOpt(jint fd, int level, int optname, char *optval, int *optlen);
  1347 JNIEXPORT jint JNICALL
  1348 JVM_SetSockOpt(jint fd, int level, int optname, const char *optval, int optlen);
  1350 /*
  1351  * These routines are only reentrant on Windows
  1352  */
  1354 #ifdef _WINDOWS
  1356 JNIEXPORT struct protoent * JNICALL
  1357 JVM_GetProtoByName(char* name);
  1359 JNIEXPORT struct hostent* JNICALL
  1360 JVM_GetHostByAddr(const char* name, int len, int type);
  1362 JNIEXPORT struct hostent* JNICALL
  1363 JVM_GetHostByName(char* name);
  1365 #endif /* _WINDOWS */
  1367 JNIEXPORT int JNICALL
  1368 JVM_GetHostName(char* name, int namelen);
  1370 /*
  1371  * The standard printing functions supported by the Java VM. (Should they
  1372  * be renamed to JVM_* in the future?
  1373  */
  1375 /*
  1376  * BE CAREFUL! The following functions do not implement the
  1377  * full feature set of standard C printf formats.
  1378  */
  1379 int
  1380 jio_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
  1382 int
  1383 jio_snprintf(char *str, size_t count, const char *fmt, ...);
  1385 int
  1386 jio_fprintf(FILE *, const char *fmt, ...);
  1388 int
  1389 jio_vfprintf(FILE *, const char *fmt, va_list args);
  1392 JNIEXPORT void * JNICALL
  1393 JVM_RawMonitorCreate(void);
  1395 JNIEXPORT void JNICALL
  1396 JVM_RawMonitorDestroy(void *mon);
  1398 JNIEXPORT jint JNICALL
  1399 JVM_RawMonitorEnter(void *mon);
  1401 JNIEXPORT void JNICALL
  1402 JVM_RawMonitorExit(void *mon);
  1405 #ifdef SUPPORT_OLD_REFLECTION
  1407 /*
  1408  * Support for old native code-based (pre-JDK 1.4) reflection implementation.
  1409  * Disabled by default in the product build.
  1411  * See reflection.hpp for information on SUPPORT_OLD_REFLECTION
  1412  */
  1414 /*
  1415  * reflecting fields and methods.
  1416  * which: 0 --- MEMBER_PUBLIC
  1417  *        1 --- MEMBER_DECLARED
  1418  * NOTE: absent in product build by default
  1419  */
  1421 JNIEXPORT jobjectArray JNICALL
  1422 JVM_GetClassFields(JNIEnv *env, jclass cls, jint which);
  1424 JNIEXPORT jobjectArray JNICALL
  1425 JVM_GetClassMethods(JNIEnv *env, jclass cls, jint which);
  1427 JNIEXPORT jobjectArray JNICALL
  1428 JVM_GetClassConstructors(JNIEnv *env, jclass cls, jint which);
  1430 JNIEXPORT jobject JNICALL
  1431 JVM_GetClassField(JNIEnv *env, jclass cls, jstring name, jint which);
  1433 JNIEXPORT jobject JNICALL
  1434 JVM_GetClassMethod(JNIEnv *env, jclass cls, jstring name, jobjectArray types,
  1435                    jint which);
  1436 JNIEXPORT jobject JNICALL
  1437 JVM_GetClassConstructor(JNIEnv *env, jclass cls, jobjectArray types,
  1438                         jint which);
  1440 /*
  1441  * Implements Class.newInstance
  1442  */
  1443 JNIEXPORT jobject JNICALL
  1444 JVM_NewInstance(JNIEnv *env, jclass cls);
  1446 /*
  1447  * java.lang.reflect.Field
  1448  */
  1449 JNIEXPORT jobject JNICALL
  1450 JVM_GetField(JNIEnv *env, jobject field, jobject obj);
  1452 JNIEXPORT jvalue JNICALL
  1453 JVM_GetPrimitiveField(JNIEnv *env, jobject field, jobject obj,
  1454                       unsigned char wCode);
  1456 JNIEXPORT void JNICALL
  1457 JVM_SetField(JNIEnv *env, jobject field, jobject obj, jobject val);
  1459 JNIEXPORT void JNICALL
  1460 JVM_SetPrimitiveField(JNIEnv *env, jobject field, jobject obj, jvalue v,
  1461                       unsigned char vCode);
  1463 /*
  1464  * java.lang.reflect.Method
  1465  */
  1466 JNIEXPORT jobject JNICALL
  1467 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
  1469 /*
  1470  * java.lang.reflect.Constructor
  1471  */
  1472 JNIEXPORT jobject JNICALL
  1473 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
  1475 #endif /* SUPPORT_OLD_REFLECTION */
  1477 /*
  1478  * java.lang.management support
  1479  */
  1480 JNIEXPORT void* JNICALL
  1481 JVM_GetManagement(jint version);
  1483 /*
  1484  * com.sun.tools.attach.VirtualMachine support
  1486  * Initialize the agent properties with the properties maintained in the VM.
  1487  */
  1488 JNIEXPORT jobject JNICALL
  1489 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
  1491 /* Generics reflection support.
  1493  * Returns information about the given class's EnclosingMethod
  1494  * attribute, if present, or null if the class had no enclosing
  1495  * method.
  1497  * If non-null, the returned array contains three elements. Element 0
  1498  * is the java.lang.Class of which the enclosing method is a member,
  1499  * and elements 1 and 2 are the java.lang.Strings for the enclosing
  1500  * method's name and descriptor, respectively.
  1501  */
  1502 JNIEXPORT jobjectArray JNICALL
  1503 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
  1505 /*
  1506  * Java thread state support
  1507  */
  1508 enum {
  1509     JAVA_THREAD_STATE_NEW           = 0,
  1510     JAVA_THREAD_STATE_RUNNABLE      = 1,
  1511     JAVA_THREAD_STATE_BLOCKED       = 2,
  1512     JAVA_THREAD_STATE_WAITING       = 3,
  1513     JAVA_THREAD_STATE_TIMED_WAITING = 4,
  1514     JAVA_THREAD_STATE_TERMINATED    = 5,
  1515     JAVA_THREAD_STATE_COUNT         = 6
  1516 };
  1518 /*
  1519  * Returns an array of the threadStatus values representing the
  1520  * given Java thread state.  Returns NULL if the VM version is
  1521  * incompatible with the JDK or doesn't support the given
  1522  * Java thread state.
  1523  */
  1524 JNIEXPORT jintArray JNICALL
  1525 JVM_GetThreadStateValues(JNIEnv* env, jint javaThreadState);
  1527 /*
  1528  * Returns an array of the substate names representing the
  1529  * given Java thread state.  Returns NULL if the VM version is
  1530  * incompatible with the JDK or the VM doesn't support
  1531  * the given Java thread state.
  1532  * values must be the jintArray returned from JVM_GetThreadStateValues
  1533  * and javaThreadState.
  1534  */
  1535 JNIEXPORT jobjectArray JNICALL
  1536 JVM_GetThreadStateNames(JNIEnv* env, jint javaThreadState, jintArray values);
  1538 /* =========================================================================
  1539  * The following defines a private JVM interface that the JDK can query
  1540  * for the JVM version and capabilities.  sun.misc.Version defines
  1541  * the methods for getting the VM version and its capabilities.
  1543  * When a new bit is added, the following should be updated to provide
  1544  * access to the new capability:
  1545  *    HS:   JVM_GetVersionInfo and Abstract_VM_Version class
  1546  *    SDK:  Version class
  1548  * Similary, a private JDK interface JDK_GetVersionInfo0 is defined for
  1549  * JVM to query for the JDK version and capabilities.
  1551  * When a new bit is added, the following should be updated to provide
  1552  * access to the new capability:
  1553  *    HS:   JDK_Version class
  1554  *    SDK:  JDK_GetVersionInfo0
  1556  * ==========================================================================
  1557  */
  1558 typedef struct {
  1559     /* HotSpot Express VM version string:
  1560      * <major>.<minor>-bxx[-<identifier>][-<debug_flavor>]
  1561      */
  1562     unsigned int jvm_version; /* Consists of major.minor.0.build */
  1563     unsigned int update_version : 8;         /* 0 in HotSpot Express VM */
  1564     unsigned int special_update_version : 8; /* 0 in HotSpot Express VM */
  1565     unsigned int reserved1 : 16;
  1566     unsigned int reserved2;
  1568     /* The following bits represents JVM supports that JDK has dependency on.
  1569      * JDK can use these bits to determine which JVM version
  1570      * and support it has to maintain runtime compatibility.
  1572      * When a new bit is added in a minor or update release, make sure
  1573      * the new bit is also added in the main/baseline.
  1574      */
  1575     unsigned int is_attachable : 1;
  1576     unsigned int is_kernel_jvm : 1;
  1577     unsigned int : 30;
  1578     unsigned int : 32;
  1579     unsigned int : 32;
  1580 } jvm_version_info;
  1582 #define JVM_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
  1583 #define JVM_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
  1584 // Micro version is 0 in HotSpot Express VM (set in jvm.cpp).
  1585 #define JVM_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
  1586 /* Build number is available in all HotSpot Express VM builds.
  1587  * It is defined in make/hotspot_version file.
  1588  */
  1589 #define JVM_VERSION_BUILD(version) ((version & 0x000000FF))
  1591 JNIEXPORT void JNICALL
  1592 JVM_GetVersionInfo(JNIEnv* env, jvm_version_info* info, size_t info_size);
  1594 typedef struct {
  1595     // Naming convention of RE build version string: n.n.n[_uu[c]][-<identifier>]-bxx
  1596     unsigned int jdk_version;   /* Consists of major, minor, micro (n.n.n) */
  1597                                 /* and build number (xx) */
  1598     unsigned int update_version : 8;         /* Update release version (uu) */
  1599     unsigned int special_update_version : 8; /* Special update release version (c)*/
  1600     unsigned int reserved1 : 16;
  1601     unsigned int reserved2;
  1603     /* The following bits represents new JDK supports that VM has dependency on.
  1604      * VM implementation can use these bits to determine which JDK version
  1605      * and support it has to maintain runtime compatibility.
  1607      * When a new bit is added in a minor or update release, make sure
  1608      * the new bit is also added in the main/baseline.
  1609      */
  1610     unsigned int thread_park_blocker : 1;
  1611     unsigned int : 31;
  1612     unsigned int : 32;
  1613     unsigned int : 32;
  1614 } jdk_version_info;
  1616 #define JDK_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
  1617 #define JDK_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
  1618 #define JDK_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
  1620 /* Build number is available only for RE build (i.e. JDK_BUILD_NUMBER is set to bNN)
  1621  * It will be zero for internal builds.
  1622  */
  1623 #define JDK_VERSION_BUILD(version) ((version & 0x000000FF))
  1625 /*
  1626  * This is the function JDK_GetVersionInfo0 defined in libjava.so
  1627  * that is dynamically looked up by JVM.
  1628  */
  1629 typedef void (*jdk_version_info_fn_t)(jdk_version_info* info, size_t info_size);
  1631 /*
  1632  * This structure is used by the launcher to get the default thread
  1633  * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
  1634  * version of 1.1.  As it is not supported otherwise, it has been removed
  1635  * from jni.h
  1636  */
  1637 typedef struct JDK1_1InitArgs {
  1638     jint version;
  1640     char **properties;
  1641     jint checkSource;
  1642     jint nativeStackSize;
  1643     jint javaStackSize;
  1644     jint minHeapSize;
  1645     jint maxHeapSize;
  1646     jint verifyMode;
  1647     char *classpath;
  1649     jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
  1650     void (JNICALL *exit)(jint code);
  1651     void (JNICALL *abort)(void);
  1653     jint enableClassGC;
  1654     jint enableVerboseGC;
  1655     jint disableAsyncGC;
  1656     jint verbose;
  1657     jboolean debugging;
  1658     jint debugPort;
  1659 } JDK1_1InitArgs;
  1661 #ifdef __cplusplus
  1662 } /* extern "C" */
  1663 #endif /* __cplusplus */
  1665 #endif /* !_JAVASOFT_JVM_H_ */

mercurial