< prev index next >

src/hotspot/share/prims/jvmti.xml

Print this page

 1707         </param>
 1708         <param id="results">
 1709           <outbuf incount="request_count"><enum>jvmtiError</enum></outbuf>
 1710           <description>
 1711             An agent supplied array of
 1712             <paramlink id="request_count"></paramlink> elements.
 1713             On return, filled with the error code for
 1714             the suspend of the corresponding thread.
 1715             The error code will be
 1716             <errorlink id="JVMTI_ERROR_NONE"></errorlink>
 1717             if the thread was suspended by this call.
 1718             Possible error codes are those specified
 1719             for <functionlink id="SuspendThread"></functionlink>.
 1720           </description>
 1721         </param>
 1722       </parameters>
 1723       <errors>
 1724       </errors>
 1725     </function>
 1726 
 1727     <function id="SuspendAllVirtualThreads" num="118" since="19">
 1728       <synopsis>Suspend All Virtual Threads</synopsis>
 1729       <description>
 1730         <b> SuspendAllVirtualThreads is a preview API of the Java platform. </b>
 1731         <i>Preview features may be removed in a future release, or upgraded to
 1732         permanent features of the Java platform.</i>
 1733         <p/>
 1734         Suspend all virtual threads except those in the exception list.
 1735         Virtual threads that are currently suspended do not change state.
 1736         Virtual threads may be resumed with
 1737         <functionlink id="ResumeAllVirtualThreads"></functionlink> or
 1738         <functionlink id="ResumeThreadList"></functionlink> or
 1739         <functionlink id="ResumeThread"></functionlink>.
 1740       </description>
 1741       <origin>new</origin>
 1742       <capabilities>
 1743         <required id="can_suspend"></required>
 1744         <required id="can_support_virtual_threads">Can support virtual threads</required>
 1745       </capabilities>
 1746       <parameters>
 1747         <param id="except_count">
 1748           <jint min="0"/>
 1749           <description>
 1750             The number of threads in the list of threads not to be suspended.
 1751           </description>
 1752         </param>
 1753         <param id="except_list">

 1833         </param>
 1834         <param id="results">
 1835           <outbuf incount="request_count"><enum>jvmtiError</enum></outbuf>
 1836           <description>
 1837             An agent supplied array of
 1838             <paramlink id="request_count"></paramlink> elements.
 1839             On return, filled with the error code for
 1840             the resume of the corresponding thread.
 1841             The error code will be
 1842             <errorlink id="JVMTI_ERROR_NONE"></errorlink>
 1843             if the thread was suspended by this call.
 1844             Possible error codes are those specified
 1845             for <functionlink id="ResumeThread"></functionlink>.
 1846           </description>
 1847         </param>
 1848       </parameters>
 1849       <errors>
 1850       </errors>
 1851     </function>
 1852 
 1853    <function id="ResumeAllVirtualThreads" num="119" since="19">
 1854       <synopsis>Resume All Virtual Threads</synopsis>
 1855       <description>
 1856         <b> ResumeAllVirtualThreads is a preview API of the Java platform. </b>
 1857         <i>Preview features may be removed in a future release, or upgraded to
 1858         permanent features of the Java platform.</i>
 1859         <p/>
 1860         Resume all virtual threads except those in the exception list.
 1861         Virtual threads that are currently resumed do not change state.
 1862         Virtual threads may be suspended with
 1863         <functionlink id="SuspendAllVirtualThreads"></functionlink> or
 1864         <functionlink id="SuspendThreadList"></functionlink> or
 1865         <functionlink id="SuspendThread"></functionlink>.
 1866       </description>
 1867       <origin>new</origin>
 1868       <capabilities>
 1869         <required id="can_suspend"></required>
 1870         <required id="can_support_virtual_threads">Can support virtual threads</required>
 1871       </capabilities>
 1872       <parameters>
 1873         <param id="except_count">
 1874           <jint min="0"/>
 1875           <description>
 1876             The number of threads in the list of threads not to be resumed.
 1877           </description>
 1878         </param>
 1879         <param id="except_list">

10633       </capabilityfield>
10634       <capabilityfield id="can_generate_early_class_hook_events" since="9">
10635         <description>
10636           Can generate the <eventlink id="ClassFileLoadHook"/> events
10637           in the primordial phase. If this capability and
10638           <internallink id="jvmtiCapabilities.can_generate_all_class_hook_events">
10639           <code>can_generate_all_class_hook_events</code></internallink>
10640           are enabled then the <eventlink id="ClassFileLoadHook"/> events
10641           can be posted for classes loaded in the primordial phase.
10642           See <eventlink id="ClassFileLoadHook"/>.
10643         </description>
10644       </capabilityfield>
10645       <capabilityfield id="can_generate_sampled_object_alloc_events" since="11">
10646         <description>
10647           Can generate sampled allocation events.
10648           If this capability is enabled then the heap sampling method
10649           <functionlink id="SetHeapSamplingInterval"></functionlink> can be
10650           called and <eventlink id="SampledObjectAlloc"></eventlink> events can be generated.
10651         </description>
10652       </capabilityfield>
10653       <capabilityfield id="can_support_virtual_threads" since="19">
10654         <description>
10655           <b> can_support_virtual_threads is a preview API of the Java platform. </b>
10656           <i>Preview features may be removed in a future release, or upgraded to
10657           permanent features of the Java platform.</i>
10658           <p/>
10659           Can support virtual threads.
10660           If this capability is enabled then the following functions can be called:
10661           <functionlink id="SuspendAllVirtualThreads"></functionlink>,
10662           <functionlink id="ResumeAllVirtualThreads"></functionlink>,
10663           and the following events can be enabled:
10664           <eventlink id="VirtualThreadStart"></eventlink>,
10665           <eventlink id="VirtualThreadEnd"></eventlink>.
10666         </description>
10667       </capabilityfield>
10668     </capabilitiestypedef>
10669 
10670     <function id="GetPotentialCapabilities" jkernel="yes" phase="onload" num="140">
10671       <synopsis>Get Potential Capabilities</synopsis>
10672       <description>
10673         Returns via <paramlink id="capabilities_ptr"></paramlink> the <jvmti/>
10674         features that can potentially be possessed by this environment
10675         at this time.
10676         The returned capabilities differ from the complete set of capabilities
10677         implemented by the VM in two cases: another environment possesses
10678         capabilities that can only be possessed by one environment, or the

13019     </capabilities>
13020     <parameters>
13021       <param id="jni_env">
13022         <outptr>
13023           <struct>JNIEnv</struct>
13024         </outptr>
13025           <description>
13026             The JNI environment of the event (current) thread.
13027           </description>
13028       </param>
13029       <param id="thread">
13030         <jthread/>
13031           <description>
13032             Thread ending
13033           </description>
13034       </param>
13035     </parameters>
13036   </event>
13037 
13038  <event label="Virtual Thread Start"
13039          id="VirtualThreadStart" const="JVMTI_EVENT_VIRTUAL_THREAD_START" filtered="thread" num="87" phase="start" since="19">
13040     <description>
13041       <b> VirtualThreadStart is a preview API of the Java platform. </b>
13042       <i>Preview features may be removed in a future release, or upgraded to
13043       permanent features of the Java platform.</i>
13044       <p/>
13045       A virtual thread start event is generated before its initial method executes.
13046       <p/>
13047       The event is sent on the newly started <paramlink id="virtual_thread"></paramlink>.
13048     </description>
13049     <origin>new</origin>
13050     <capabilities>
13051       <required id="can_support_virtual_threads">Can support virtual threads</required>
13052     </capabilities>
13053     <parameters>
13054       <param id="jni_env">
13055         <outptr>
13056           <struct>JNIEnv</struct>
13057         </outptr>
13058           <description>
13059             The JNI environment of the event (current) thread.
13060           </description>
13061       </param>
13062       <param id="virtual_thread">
13063         <jthread/>
13064           <description>
13065             Virtual thread started for execution.
13066           </description>
13067       </param>
13068     </parameters>
13069   </event>
13070 
13071   <event label="Virtual Thread End"
13072          id="VirtualThreadEnd" const="JVMTI_EVENT_VIRTUAL_THREAD_END" filtered="thread" num="88" phase="start" since="19">
13073     <description>
13074       <b> VirtualThreadEnd is a preview API of the Java platform. </b>
13075       <i>Preview features may be removed in a future release, or upgraded to
13076       permanent features of the Java platform.</i>
13077       <p/>
13078       A virtual thread end event is generated after its initial method has finished execution.
13079       <p/>
13080       The event is sent on the terminating <paramlink id="virtual_thread"></paramlink>.
13081     </description>
13082     <origin>new</origin>
13083     <capabilities>
13084       <required id="can_support_virtual_threads">Can support virtual threads</required>
13085     </capabilities>
13086     <parameters>
13087       <param id="jni_env">
13088         <outptr>
13089           <struct>JNIEnv</struct>
13090         </outptr>
13091           <description>
13092             The JNI environment of the event (current) thread.
13093           </description>
13094       </param>
13095       <param id="virtual_thread">
13096         <jthread/>
13097           <description>

 1707         </param>
 1708         <param id="results">
 1709           <outbuf incount="request_count"><enum>jvmtiError</enum></outbuf>
 1710           <description>
 1711             An agent supplied array of
 1712             <paramlink id="request_count"></paramlink> elements.
 1713             On return, filled with the error code for
 1714             the suspend of the corresponding thread.
 1715             The error code will be
 1716             <errorlink id="JVMTI_ERROR_NONE"></errorlink>
 1717             if the thread was suspended by this call.
 1718             Possible error codes are those specified
 1719             for <functionlink id="SuspendThread"></functionlink>.
 1720           </description>
 1721         </param>
 1722       </parameters>
 1723       <errors>
 1724       </errors>
 1725     </function>
 1726 
 1727     <function id="SuspendAllVirtualThreads" num="118" since="21">
 1728       <synopsis>Suspend All Virtual Threads</synopsis>
 1729       <description>




 1730         Suspend all virtual threads except those in the exception list.
 1731         Virtual threads that are currently suspended do not change state.
 1732         Virtual threads may be resumed with
 1733         <functionlink id="ResumeAllVirtualThreads"></functionlink> or
 1734         <functionlink id="ResumeThreadList"></functionlink> or
 1735         <functionlink id="ResumeThread"></functionlink>.
 1736       </description>
 1737       <origin>new</origin>
 1738       <capabilities>
 1739         <required id="can_suspend"></required>
 1740         <required id="can_support_virtual_threads">Can support virtual threads</required>
 1741       </capabilities>
 1742       <parameters>
 1743         <param id="except_count">
 1744           <jint min="0"/>
 1745           <description>
 1746             The number of threads in the list of threads not to be suspended.
 1747           </description>
 1748         </param>
 1749         <param id="except_list">

 1829         </param>
 1830         <param id="results">
 1831           <outbuf incount="request_count"><enum>jvmtiError</enum></outbuf>
 1832           <description>
 1833             An agent supplied array of
 1834             <paramlink id="request_count"></paramlink> elements.
 1835             On return, filled with the error code for
 1836             the resume of the corresponding thread.
 1837             The error code will be
 1838             <errorlink id="JVMTI_ERROR_NONE"></errorlink>
 1839             if the thread was suspended by this call.
 1840             Possible error codes are those specified
 1841             for <functionlink id="ResumeThread"></functionlink>.
 1842           </description>
 1843         </param>
 1844       </parameters>
 1845       <errors>
 1846       </errors>
 1847     </function>
 1848 
 1849    <function id="ResumeAllVirtualThreads" num="119" since="21">
 1850       <synopsis>Resume All Virtual Threads</synopsis>
 1851       <description>




 1852         Resume all virtual threads except those in the exception list.
 1853         Virtual threads that are currently resumed do not change state.
 1854         Virtual threads may be suspended with
 1855         <functionlink id="SuspendAllVirtualThreads"></functionlink> or
 1856         <functionlink id="SuspendThreadList"></functionlink> or
 1857         <functionlink id="SuspendThread"></functionlink>.
 1858       </description>
 1859       <origin>new</origin>
 1860       <capabilities>
 1861         <required id="can_suspend"></required>
 1862         <required id="can_support_virtual_threads">Can support virtual threads</required>
 1863       </capabilities>
 1864       <parameters>
 1865         <param id="except_count">
 1866           <jint min="0"/>
 1867           <description>
 1868             The number of threads in the list of threads not to be resumed.
 1869           </description>
 1870         </param>
 1871         <param id="except_list">

10625       </capabilityfield>
10626       <capabilityfield id="can_generate_early_class_hook_events" since="9">
10627         <description>
10628           Can generate the <eventlink id="ClassFileLoadHook"/> events
10629           in the primordial phase. If this capability and
10630           <internallink id="jvmtiCapabilities.can_generate_all_class_hook_events">
10631           <code>can_generate_all_class_hook_events</code></internallink>
10632           are enabled then the <eventlink id="ClassFileLoadHook"/> events
10633           can be posted for classes loaded in the primordial phase.
10634           See <eventlink id="ClassFileLoadHook"/>.
10635         </description>
10636       </capabilityfield>
10637       <capabilityfield id="can_generate_sampled_object_alloc_events" since="11">
10638         <description>
10639           Can generate sampled allocation events.
10640           If this capability is enabled then the heap sampling method
10641           <functionlink id="SetHeapSamplingInterval"></functionlink> can be
10642           called and <eventlink id="SampledObjectAlloc"></eventlink> events can be generated.
10643         </description>
10644       </capabilityfield>
10645       <capabilityfield id="can_support_virtual_threads" since="21">
10646         <description>




10647           Can support virtual threads.
10648           If this capability is enabled then the following functions can be called:
10649           <functionlink id="SuspendAllVirtualThreads"></functionlink>,
10650           <functionlink id="ResumeAllVirtualThreads"></functionlink>,
10651           and the following events can be enabled:
10652           <eventlink id="VirtualThreadStart"></eventlink>,
10653           <eventlink id="VirtualThreadEnd"></eventlink>.
10654         </description>
10655       </capabilityfield>
10656     </capabilitiestypedef>
10657 
10658     <function id="GetPotentialCapabilities" jkernel="yes" phase="onload" num="140">
10659       <synopsis>Get Potential Capabilities</synopsis>
10660       <description>
10661         Returns via <paramlink id="capabilities_ptr"></paramlink> the <jvmti/>
10662         features that can potentially be possessed by this environment
10663         at this time.
10664         The returned capabilities differ from the complete set of capabilities
10665         implemented by the VM in two cases: another environment possesses
10666         capabilities that can only be possessed by one environment, or the

13007     </capabilities>
13008     <parameters>
13009       <param id="jni_env">
13010         <outptr>
13011           <struct>JNIEnv</struct>
13012         </outptr>
13013           <description>
13014             The JNI environment of the event (current) thread.
13015           </description>
13016       </param>
13017       <param id="thread">
13018         <jthread/>
13019           <description>
13020             Thread ending
13021           </description>
13022       </param>
13023     </parameters>
13024   </event>
13025 
13026  <event label="Virtual Thread Start"
13027          id="VirtualThreadStart" const="JVMTI_EVENT_VIRTUAL_THREAD_START" filtered="thread" num="87" phase="start" since="21">
13028     <description>




13029       A virtual thread start event is generated before its initial method executes.
13030       <p/>
13031       The event is sent on the newly started <paramlink id="virtual_thread"></paramlink>.
13032     </description>
13033     <origin>new</origin>
13034     <capabilities>
13035       <required id="can_support_virtual_threads">Can support virtual threads</required>
13036     </capabilities>
13037     <parameters>
13038       <param id="jni_env">
13039         <outptr>
13040           <struct>JNIEnv</struct>
13041         </outptr>
13042           <description>
13043             The JNI environment of the event (current) thread.
13044           </description>
13045       </param>
13046       <param id="virtual_thread">
13047         <jthread/>
13048           <description>
13049             Virtual thread started for execution.
13050           </description>
13051       </param>
13052     </parameters>
13053   </event>
13054 
13055   <event label="Virtual Thread End"
13056          id="VirtualThreadEnd" const="JVMTI_EVENT_VIRTUAL_THREAD_END" filtered="thread" num="88" phase="start" since="21">
13057     <description>




13058       A virtual thread end event is generated after its initial method has finished execution.
13059       <p/>
13060       The event is sent on the terminating <paramlink id="virtual_thread"></paramlink>.
13061     </description>
13062     <origin>new</origin>
13063     <capabilities>
13064       <required id="can_support_virtual_threads">Can support virtual threads</required>
13065     </capabilities>
13066     <parameters>
13067       <param id="jni_env">
13068         <outptr>
13069           <struct>JNIEnv</struct>
13070         </outptr>
13071           <description>
13072             The JNI environment of the event (current) thread.
13073           </description>
13074       </param>
13075       <param id="virtual_thread">
13076         <jthread/>
13077           <description>
< prev index next >