< prev index next >

src/hotspot/share/prims/jvmti.xml

Print this page

    1 <?xml version="1.0" encoding="UTF-8"?>
    2 <?xml-stylesheet type="text/xsl" href="jvmti.xsl"?>
    3 <!--
    4  Copyright (c) 2002, 2025, Oracle and/or its affiliates. All rights reserved.
    5  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    6 
    7  This code is free software; you can redistribute it and/or modify it
    8  under the terms of the GNU General Public License version 2 only, as
    9  published by the Free Software Foundation.
   10 
   11  This code is distributed in the hope that it will be useful, but WITHOUT
   12  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14  version 2 for more details (a copy is included in the LICENSE file that
   15  accompanied this code).
   16 
   17  You should have received a copy of the GNU General Public License version
   18  2 along with this work; if not, write to the Free Software Foundation,
   19  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20 
   21  Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22  or visit www.oracle.com if you need additional information or have any
   23  questions.
   24 -->

 5871           <description>
 5872             The thread of the frame containing the variable's value.
 5873           </description>
 5874         </param>
 5875         <param id="depth">
 5876           <jframeID thread="thread"/>
 5877           <description>
 5878             The depth of the frame containing the variable's value.
 5879           </description>
 5880         </param>
 5881         <param id="slot">
 5882           <jint/>
 5883           <description>
 5884             The variable's slot number.
 5885           </description>
 5886         </param>
 5887         <param id="value_ptr">
 5888           <outptr><jobject/></outptr>
 5889             <description>
 5890               On return, points to the variable's value.



 5891             </description>
 5892         </param>
 5893       </parameters>
 5894       <errors>
 5895         <error id="JVMTI_ERROR_INVALID_SLOT">
 5896           Invalid <code>slot</code>.
 5897         </error>
 5898         <error id="JVMTI_ERROR_TYPE_MISMATCH">
 5899           The variable type is not
 5900           <code>Object</code> or a subclass of <code>Object</code>.
 5901         </error>
 5902         <error id="JVMTI_ERROR_OPAQUE_FRAME">
 5903           The implementation is unable to get the frame locals
 5904           (e.g. the frame at <code>depth</code> is executing a native method).
 5905         </error>
 5906         <error id="JVMTI_ERROR_THREAD_NOT_SUSPENDED">
 5907           Thread was not suspended and was not the current thread.
 5908         </error>
 5909       </errors>
 5910     </function>

 5924       <capabilities>
 5925         <required id="can_access_local_variables"></required>
 5926       </capabilities>
 5927       <parameters>
 5928         <param id="thread">
 5929           <jthread null="current" frame="frame" impl="noconvert"/>
 5930           <description>
 5931             The thread of the frame containing the variable's value.
 5932           </description>
 5933         </param>
 5934         <param id="depth">
 5935           <jframeID thread="thread"/>
 5936           <description>
 5937             The depth of the frame containing the variable's value.
 5938           </description>
 5939         </param>
 5940         <param id="value_ptr">
 5941           <outptr><jobject/></outptr>
 5942             <description>
 5943               On return, points to the variable's value.


 5944             </description>
 5945         </param>
 5946       </parameters>
 5947       <errors>
 5948         <error id="JVMTI_ERROR_INVALID_SLOT">
 5949           If the specified frame is a static method frame.
 5950         </error>
 5951         <error id="JVMTI_ERROR_THREAD_NOT_SUSPENDED">
 5952           Thread was not suspended and was not the current thread.
 5953         </error>
 5954       </errors>
 5955     </function>
 5956     <function id="GetLocalInt" num="22">
 5957       <synopsis>Get Local Variable - Int</synopsis>
 5958       <description>
 5959         This function can be used to retrieve the value of a local
 5960         variable whose type is <code>int</code>,
 5961         <code>short</code>, <code>char</code>, <code>byte</code>, or
 5962         <code>boolean</code>.
 5963         <p/>

    1 <?xml version="1.0" encoding="UTF-8"?>
    2 <?xml-stylesheet type="text/xsl" href="jvmti.xsl"?>
    3 <!--
    4  Copyright (c) 2002, 2026, Oracle and/or its affiliates. All rights reserved.
    5  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    6 
    7  This code is free software; you can redistribute it and/or modify it
    8  under the terms of the GNU General Public License version 2 only, as
    9  published by the Free Software Foundation.
   10 
   11  This code is distributed in the hope that it will be useful, but WITHOUT
   12  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14  version 2 for more details (a copy is included in the LICENSE file that
   15  accompanied this code).
   16 
   17  You should have received a copy of the GNU General Public License version
   18  2 along with this work; if not, write to the Free Software Foundation,
   19  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20 
   21  Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22  or visit www.oracle.com if you need additional information or have any
   23  questions.
   24 -->

 5871           <description>
 5872             The thread of the frame containing the variable's value.
 5873           </description>
 5874         </param>
 5875         <param id="depth">
 5876           <jframeID thread="thread"/>
 5877           <description>
 5878             The depth of the frame containing the variable's value.
 5879           </description>
 5880         </param>
 5881         <param id="slot">
 5882           <jint/>
 5883           <description>
 5884             The variable's slot number.
 5885           </description>
 5886         </param>
 5887         <param id="value_ptr">
 5888           <outptr><jobject/></outptr>
 5889             <description>
 5890               On return, points to the variable's value.
 5891               If the frame's method is a value object constructor and
 5892               the requested local is the "<code>this</code>" object, the
 5893               value_ptr is set to a snapshot of the "<code>this</code>" object.
 5894             </description>
 5895         </param>
 5896       </parameters>
 5897       <errors>
 5898         <error id="JVMTI_ERROR_INVALID_SLOT">
 5899           Invalid <code>slot</code>.
 5900         </error>
 5901         <error id="JVMTI_ERROR_TYPE_MISMATCH">
 5902           The variable type is not
 5903           <code>Object</code> or a subclass of <code>Object</code>.
 5904         </error>
 5905         <error id="JVMTI_ERROR_OPAQUE_FRAME">
 5906           The implementation is unable to get the frame locals
 5907           (e.g. the frame at <code>depth</code> is executing a native method).
 5908         </error>
 5909         <error id="JVMTI_ERROR_THREAD_NOT_SUSPENDED">
 5910           Thread was not suspended and was not the current thread.
 5911         </error>
 5912       </errors>
 5913     </function>

 5927       <capabilities>
 5928         <required id="can_access_local_variables"></required>
 5929       </capabilities>
 5930       <parameters>
 5931         <param id="thread">
 5932           <jthread null="current" frame="frame" impl="noconvert"/>
 5933           <description>
 5934             The thread of the frame containing the variable's value.
 5935           </description>
 5936         </param>
 5937         <param id="depth">
 5938           <jframeID thread="thread"/>
 5939           <description>
 5940             The depth of the frame containing the variable's value.
 5941           </description>
 5942         </param>
 5943         <param id="value_ptr">
 5944           <outptr><jobject/></outptr>
 5945             <description>
 5946               On return, points to the variable's value.
 5947               If the frame's method is a value object constructor, the 
 5948               value_ptr is set to a snapshot of the "<code>this</code>" object.
 5949             </description>
 5950         </param>
 5951       </parameters>
 5952       <errors>
 5953         <error id="JVMTI_ERROR_INVALID_SLOT">
 5954           If the specified frame is a static method frame.
 5955         </error>
 5956         <error id="JVMTI_ERROR_THREAD_NOT_SUSPENDED">
 5957           Thread was not suspended and was not the current thread.
 5958         </error>
 5959       </errors>
 5960     </function>
 5961     <function id="GetLocalInt" num="22">
 5962       <synopsis>Get Local Variable - Int</synopsis>
 5963       <description>
 5964         This function can be used to retrieve the value of a local
 5965         variable whose type is <code>int</code>,
 5966         <code>short</code>, <code>char</code>, <code>byte</code>, or
 5967         <code>boolean</code>.
 5968         <p/>
< prev index next >