jvm.h revision 2362
6330N/A * Copyright (c) 1997, 2008, Oracle and/or its affiliates. All rights reserved. 3012N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 6330N/A * This code is free software; you can redistribute it and/or modify it 6330N/A * under the terms of the GNU General Public License version 2 only, as 6330N/A * published by the Free Software Foundation. Oracle designates this 233N/A * particular file as subject to the "Classpath" exception as provided 6330N/A * by Oracle in the LICENSE file that accompanied this code. 6330N/A * This code is distributed in the hope that it will be useful, but WITHOUT 6330N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 6330N/A * version 2 for more details (a copy is included in the LICENSE file that 6330N/A * You should have received a copy of the GNU General Public License version 6330N/A * 2 along with this work; if not, write to the Free Software Foundation, 6330N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 6330N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 6330N/A * This file contains additional functions exported from the VM. 6330N/A * These functions are complementary to the standard JNI support. 6330N/A * There are three parts to this file: 6331N/A * First, this file contains the VM-related functions needed by native 6330N/A * libraries in the standard Java API. For example, the java.lang.Object 6330N/A * class needs VM-level functions that wait for and notify monitors. 6330N/A * Second, this file contains the functions and constant definitions 6330N/A * needed by the byte code verifier and class file format checker. 6301N/A * These functions allow the verifier and format checker to be written 3012N/A * Third, this file contains various I/O and nerwork operations needed 6330N/A * by the standard Java I/O and network APIs. 6331N/A * Bump the version number when either of the following happens: 233N/A * 1. There is a change in JVM_* functions. 6330N/A * 2. There is a change in the contract between VM and Java classes. 6330N/A * For example, if the VM relies on a new private field in Thread 6330N/A/************************************************************************* 6330N/A PART 1: Functions for Native Libraries 6330N/A ************************************************************************/ 6330N/A/* Returns the number of real-time milliseconds that have elapsed since the 3381N/A * least-recently-inspected heap object was last inspected by the garbage 0N/A * For simple stop-the-world collectors this value is just the time 6330N/A * since the most recent collection. For generational collectors it is the 6330N/A * time since the oldest generation was most recently collected. Other 6330N/A * collectors are free to return a pessimistic estimate of the elapsed time, or 1177N/A * simply the time since the last full collection was performed. 6330N/A * Note that in the presence of reference objects, a given object that is no 6330N/A * longer strongly reachable may have to be inspected multiple times before it 6330N/A * java.lang.Float and java.lang.Double 6302N/A/* getStackTrace() and getAllStackTraces() method */ 6302N/A * java.lang.SecurityManager 0N/A * java.io.ObjectInputStream 6330N/A * This function has been deprecated and should not be considered 6330N/A * part of the specified JVM interface. 6330N/A * java.lang.Class and java.lang.ClassLoader 712N/A * Returns the class in which the code invoking the native method 6330N/A * Note that in JDK 1.1, native methods did not create a frame. 6330N/A * In 1.2, they do. Therefore native methods like Class.forName 6330N/A * can no longer look at the current frame for the caller class. 6330N/A * Find a class from a boot class loader. Returns NULL if class not found. 6330N/A * Find a class from a given class loader. Throw ClassNotFoundException 0N/A * or NoClassDefFoundError depending on the value of the last 6330N/A * Find a class from a given class. 6330N/A/* Find a loaded class cached by the VM */ 6330N/A/* Define a class with a source (added in JDK1.5) */ 6330N/A * Reflection support functions 6330N/A/* Generics support (JDK 1.5) */ 6330N/A/* Annotations support (JDK 1.5) */ 6330N/A * New (JDK 1.4) reflection implementation 5058N/A/* Differs from JVM_GetClassModifiers in treatment of inner classes. 6330N/A This returns the access flags for the class as specified in the 6330N/A class file rather than searching the InnerClasses attribute (if 6330N/A present) to find the source-level access flags. Only the values of 6330N/A the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be 6330N/A/* The following two reflection routines are still needed due to startup time issues */ 6330N/A * java.lang.reflect.Constructor 6330N/A * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5) 6330N/A * Signal support, used to implement the shutdown sequence. Every VM must 6330N/A * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts 6330N/A * (^C) and the latter for external termination (kill, system shutdown, etc.). 6330N/A * Other platform-dependent signal values may also be supported. 6330N/A * Retrieve the assertion directives for the specified class. 6330N/A * Retrieve the assertion directives from the VM. 6330N/A * Structure to pass one probe description to JVM 6330N/A * Encapsulates the stability ratings for a DTrace provider field 6330N/A * Structure to pass one provider description to JVM 6330N/A * Get the version number the JVM was built with 6330N/A * Register new probe with given signature, return global handle 6330N/A * The version passed in is the version that the library code was 6330N/A * Check to see if DTrace is supported by OS 6330N/A/************************************************************************* 6330N/A PART 2: Support for the Verifier and Class File Format Checker 6330N/A ************************************************************************/ 6330N/A * Return the class name in UTF format. The result is valid 6330N/A * until JVM_ReleaseUTf is called. 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the constant pool types in the buffer provided by "types." 6330N/A * Returns the number of Constant Pool entries. 6330N/A * Returns the number of *declared* fields or methods. 6330N/A * Returns the CP indexes of exceptions raised by a given method. 6330N/A * Places the result in the given buffer. 6330N/A * The method is identified by method_index. 6330N/A * Returns the number of exceptions raised by a given method. 6330N/A * The method is identified by method_index. 6330N/A * Returns the byte code sequence of a given method. 6330N/A * Places the result in the given buffer. 6330N/A * The method is identified by method_index. 6330N/A * Returns the length of the byte code sequence of a given method. 6330N/A * The method is identified by method_index. 6330N/A * A structure used to a capture exception table entry in a Java method. 6330N/A * Returns the exception table entry at entry_index of a given method. 6330N/A * Places the result in the given buffer. 6330N/A * The method is identified by method_index. 6330N/A * Returns the length of the exception table of a given method. 6330N/A * The method is identified by method_index. 6330N/A * Returns the modifiers of a given field. 6330N/A * The field is identified by field_index. 6330N/A * Returns the modifiers of a given method. 6330N/A * The method is identified by method_index. 6330N/A * Returns the number of local variables of a given method. 6330N/A * The method is identified by method_index. 6330N/A * Returns the number of arguments (including this pointer) of a given method. 3214N/A * The method is identified by method_index. 6330N/A * Returns the maximum amount of stack (in words) used by a given method. 6330N/A * The method is identified by method_index. 6330N/A * Is a given method a constructor. 6330N/A * The method is identified by method_index. 6330N/A * Returns the name of a given method in UTF format. 6330N/A * The result remains valid until JVM_ReleaseUTF is called. 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the signature of a given method in UTF format. 6330N/A * The result remains valid until JVM_ReleaseUTF is called. 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the name of the field refered to at a given constant pool 6330N/A * The result is in UTF format and remains valid until JVM_ReleaseUTF 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the name of the method refered to at a given constant pool 6330N/A * The result is in UTF format and remains valid until JVM_ReleaseUTF 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the signature of the method refered to at a given constant pool 6330N/A * The result is in UTF format and remains valid until JVM_ReleaseUTF 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the signature of the field refered to at a given constant pool 2086N/A * The result is in UTF format and remains valid until JVM_ReleaseUTF 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the class name refered to at a given constant pool index. 6330N/A * The result is in UTF format and remains valid until JVM_ReleaseUTF 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the class name refered to at a given constant pool index. 6330N/A * The constant pool entry must refer to a CONSTANT_Fieldref. 6330N/A * The result is in UTF format and remains valid until JVM_ReleaseUTF 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the class name refered to at a given constant pool index. 6330N/A * The constant pool entry must refer to CONSTANT_Methodref or 6330N/A * CONSTANT_InterfaceMethodref. 6330N/A * The result is in UTF format and remains valid until JVM_ReleaseUTF 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns the modifiers of a field in calledClass. The field is 2556N/A * referred to in class cb at constant pool entry index. 6330N/A * The caller must treat the string as a constant and not modify it 6330N/A * Returns -1 if the field does not exist in calledClass. 6330N/A * Returns the modifiers of a method in calledClass. The method is 6330N/A * referred to in class cb at constant pool entry index. 6330N/A * Returns -1 if the method does not exist in calledClass. 6330N/A * Releases the UTF string obtained from the VM. 6330N/A * Compare if two classes are in the same package. 6330N/A/* Get classfile constants */ 0N/A * A function defined by the byte-code verifier and called by the VM. 6330N/A * This is not a function implemented in the VM. 6330N/A * Returns JNI_FALSE if verification fails. A detailed error message 6330N/A * will be places in msg_buf, whose length is specified by buf_len. 6330N/A * Support for a VM-independent class format checker. 6330N/A * format checks. This functions fills in size information about 6330N/A * the class file and returns: 6330N/A * canonicalization. VM call this function before opening jar files 6330N/A/************************************************************************* 6330N/A PART 3: I/O and Network Support 6330N/A ************************************************************************/ 6330N/A/* Note that the JVM IO functions are expected to return JVM_IO_ERR 6330N/A * when there is any kind of error. The caller can then use the 6330N/A * platform specific support (e.g., errno) to get the detailed 6330N/A * error info. The JVM_GetLastErrorString procedure may also be used 6330N/A * to obtain a descriptive error string. 6330N/A/* For interruptible IO. Returning JVM_IO_INTR indicates that an IO 6330N/A * operation has been disrupted by Thread.interrupt. There are a 6330N/A * number of technical difficulties related to interruptible IO that 6330N/A * need to be solved. For example, most existing programs do not handle 6330N/A * InterruptedIOExceptions specially, they simply treat those as any 3069N/A * IOExceptions, which typically indicate fatal errors. 6330N/A * There are also two modes of operation for interruptible IO. In the 6330N/A * resumption mode, an interrupted IO operation is guaranteed not to 6330N/A * have any side-effects, and can be restarted. In the termination mode, 6330N/A * an interrupted IO operation corrupts the underlying IO stream, so 6330N/A * that the only reasonable operation on an interrupted stream is to 6330N/A * close that stream. The resumption mode seems to be impossible to 6330N/A * implement on Win32 and Solaris. Implementing the termination mode is 6330N/A * easier, but it's not clear that's the right semantics. 6330N/A * using a compile-time flag on Solaris. Third-party JVM ports do not 6330N/A * need to implement interruptible IO. 6330N/A/* Write a string into the given buffer, in the platform's local encoding, 6330N/A * that describes the most recent system-level error to occur in this thread. 6330N/A * Return the length of the string or zero if no error occurred. 6330N/A * Convert a pathname into native format. This function does syntactic 6330N/A * cleanup, such as removing redundant separator characters. It modifies 6330N/A * the given pathname string in place. 6330N/A * Open a file descriptor. This function returns a negative error code 6330N/A * on error, and a non-negative integer that is the file descriptor on 6330N/A * Close a file descriptor. This function returns -1 on error, and 0 6330N/A * fd the file descriptor to close. 6330N/A * Read data from a file decriptor into a char array. 6330N/A * fd the file descriptor to read from. 6330N/A * buf the buffer where to put the read data. 6330N/A * nbytes the number of bytes to read. 6330N/A * This function returns -1 on error, and 0 on success. 6330N/A * Write data from a char array to a file decriptor. 6330N/A * fd the file descriptor to read from. 6330N/A * buf the buffer from which to fetch the data. 6330N/A * nbytes the number of bytes to write. 6330N/A * This function returns -1 on error, and 0 on success. 6330N/A * Returns the number of bytes available for reading from a given file 6330N/A * Move the file descriptor pointer from whence by offset. 6330N/A * fd the file descriptor to move. 6330N/A * offset the number of bytes to move it by. 6330N/A * whence the start from where to move it. 6330N/A * This function returns the resulting pointer location. 6331N/A * Set the length of the file associated with the given descriptor to the given 6331N/A * length. If the new length is longer than the current length then the file 6331N/A * is extended; the contents of the extended portion are not defined. The 6331N/A * value of the file pointer is undefined after this procedure returns. 6331N/A * Synchronize the file descriptor's in memory state with that of the 6331N/A * physical device. Return of -1 is an error, 0 is OK. 6331N/A * Networking library support 6330N/A * The standard printing functions supported by the Java VM. (Should they 6330N/A * be renamed to JVM_* in the future? 6330N/A * BE CAREFUL! The following functions do not implement the 6330N/A * full feature set of standard C printf formats. 6330N/A * java.lang.management support 6330N/A * Initialize the agent properties with the properties maintained in the VM. 6330N/A/* Generics reflection support. 6330N/A * Returns information about the given class's EnclosingMethod 6330N/A * attribute, if present, or null if the class had no enclosing 6330N/A * If non-null, the returned array contains three elements. Element 0 6330N/A * is the java.lang.Class of which the enclosing method is a member, 6330N/A * and elements 1 and 2 are the java.lang.Strings for the enclosing 3000N/A * method's name and descriptor, respectively. 6330N/A * Java thread state support 6330N/A * Returns an array of the threadStatus values representing the 6330N/A * given Java thread state. Returns NULL if the VM version is 6330N/A * incompatible with the JDK or doesn't support the given 6330N/A * Returns an array of the substate names representing the 0N/A * given Java thread state. Returns NULL if the VM version is 6331N/A * incompatible with the JDK or the VM doesn't support 6374N/A * the given Java thread state. 6374N/A * values must be the jintArray returned from JVM_GetThreadStateValues 6330N/A/* ========================================================================= 6330N/A * The following defines a private JVM interface that the JDK can query 6330N/A * for the JVM version and capabilities. sun.misc.Version defines 6330N/A * the methods for getting the VM version and its capabilities. 6330N/A * When a new bit is added, the following should be updated to provide 6330N/A * access to the new capability: 6330N/A * HS: JVM_GetVersionInfo and Abstract_VM_Version class 6330N/A * Similary, a private JDK interface JDK_GetVersionInfo0 is defined for 6330N/A * JVM to query for the JDK version and capabilities. 6330N/A * When a new bit is added, the following should be updated to provide 6330N/A * access to the new capability: 0N/A * SDK: JDK_GetVersionInfo0 6331N/A * ========================================================================== 6331N/A /* Naming convention of RE build version string: n.n.n[_uu[c]][-<identifier>]-bxx */ 6331N/A /* and build number (xx) */ 6331N/A /* The following bits represents JVM supports that JDK has dependency on. 6331N/A * JDK can use these bits to determine which JVM version 6331N/A * and support it has to maintain runtime compatibility. 6331N/A * When a new bit is added in a minor or update release, make sure 6331N/A/* Build number is available only for RE builds. 6331N/A * It will be zero for internal builds. 6331N/A // Naming convention of RE build version string: n.n.n[_uu[c]][-<identifier>]-bxx 0N/A /* and build number (xx) */ 6331N/A /* The following bits represents new JDK supports that VM has dependency on. 6331N/A * VM implementation can use these bits to determine which JDK version 6331N/A * and support it has to maintain runtime compatibility. 6331N/A * When a new bit is added in a minor or update release, make sure 6406N/A/* Build number is available only for RE build (i.e. JDK_BUILD_NUMBER is set to bNN) 6406N/A * It will be zero for internal builds. 6406N/A * that is dynamically looked up by JVM. 0N/A * This structure is used by the launcher to get the default thread 6406N/A * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a 6406N/A * version of 1.1. As it is not supported otherwise, it has been removed 6330N/A#
endif /* !_JAVASOFT_JVM_H_ */