jdk-sandbox: comparison hotspot/src/share/vm/prims/jvmti.xml

equal deleted inserted replaced

-:0c39c59e1624
+:9bbd930be684
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <?xml-stylesheet type="text/xsl" href="jvmti.xsl"?>
 <!--
-Copyright (c) 2002, 2012, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved.
 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 This code is free software; you can redistribute it and/or modify it
 under the terms of the GNU General Public License version 2 only, as
 published by the Free Software Foundation.
 ]>
 <specification label="JVM(TM) Tool Interface"
 majorversion="1"
 minorversion="2"
-microversion="2">
+microversion="3">
 <title subtitle="Version">
 <tm>JVM</tm> Tool Interface
 </title>
 <intro id="whatIs" label="What is the JVM Tool Interface?">
 platform equivalent of a dynamic library. On the <tm>Windows</tm> operating
 system, for example, an agent library is a "Dynamic Linked Library" (DLL).
 On the <tm>Solaris</tm> Operating Environment, an agent library is a shared
 object (<code>.so</code> file).
 <p/>
 An agent may be started at VM startup by specifying the agent library
 name using a <internallink id="starting">command line option</internallink>.
 Some implementations may support a mechanism to <internallink id="onattach">
 start agents</internallink> in the live <functionlink id="GetPhase">phase</functionlink>.
 The details of how this is initiated are implementation specific.
 </intro>
+<intro id="entry point" label="Statically Linked Agents (since version 1.2.3)">
+A native JVMTI Agent may be <i>statically linked</i> with the VM.
+The manner in which the library and VM image are combined is
+implementation-dependent.
+An agent L whose image has been combined with the VM is defined as
+<i>statically linked</i> if and only if the agent exports a function
+called Agent_OnLoad_L.
+<p/>
+If a <i>statically linked</i> agent L exports a function called
+Agent_OnLoad_L and a function called Agent_OnLoad, the Agent_OnLoad
+function will be ignored.
+If an agent L is <i>statically linked</i>, an Agent_OnLoad_L
+function will be invoked with the same arguments and expected return
+value as specified for the Agent_OnLoad function.
+An agent L that is <i>statically linked</i> will prohibit an agent of
+the same name from being loaded dynamically.
+<p/>
+The VM will invoke the Agent_OnUnload_L function of the agent, if such
+a function is exported, at the same point during startup as it would
+have called the dynamic entry point Agent_OnUnLoad.
+If a <i>statically linked</i> agent L exports a function called
+Agent_OnUnLoad_L and a function called Agent_OnUnLoad, the Agent_OnUnLoad
+function will be ignored.
+<p/>
+If an agent L is <i>statically linked</i>, an Agent_OnAttach_L function
+will be invoked with the same arguments and expected return value as
+specified for the Agent_OnAttach function.
+If a <i>statically linked</i> agent L exports a function called
+Agent_OnAttach_L and a function called Agent_OnAttach, the Agent_OnAttach
+function will be ignored.
+</intro>
 <intro id="starting" label="Agent Command Line Options">
 The term "command-line option" is used below to
 mean options supplied in the <code>JavaVMInitArgs</code> argument
 to the <code>JNI_CreateJavaVM</code> function of the JNI
 <dl>
 <dt><code>-agentlib:</code><i>&lt;agent-lib-name&gt;</i><code>=</code><i>&lt;options&gt;</i></dt>
 <dd>
 	The name following <code>-agentlib:</code> is the name of the
 	library to load.  Lookup of the library, both its full name and location,
 	proceeds in a platform-specific manner.
 	Typically, the <i>&lt;agent-lib-name&gt;</i> is expanded to an
 	operating system specific file name.
 	The <i>&lt;options&gt;</i> will be passed to the agent on start-up.
 	For example, if the option
 	<code>-agentlib:foo=opt1,opt2</code> is specified, the VM will attempt to
 	load the shared library <code>foo.dll</code> from the system <code>PATH</code>
 under <tm>Windows</tm> or <code>libfoo.so</code> from the
-	<code>LD_LIBRARY_PATH</code> under the <tm>Solaris</tm> operating environment.
+	<code>LD_LIBRARY_PATH</code> under the <tm>Solaris</tm> operating
+environment.
+If the agent library is statically linked into the executable
+then no actual loading takes place.
+<p/>
 </dd>
 <dt><code>-agentpath:</code><i>&lt;path-to-agent&gt;</i><code>=</code><i>&lt;options&gt;</i></dt>
 <dd>
 	The path following <code>-agentpath:</code> is the absolute path from which
 	to load the library.
 	No library name expansion will occur.
 	The <i>&lt;options&gt;</i> will be passed to the agent on start-up.
 	For example, if the option
 	<code>-agentpath:c:\myLibs\foo.dll=opt1,opt2</code> is specified, the VM will attempt to
-	load the shared library <code>c:\myLibs\foo.dll</code>.
+	load the shared library <code>c:\myLibs\foo.dll</code>. If the agent
+library is statically linked into the executable
+then no actual loading takes place.
+<p/>
 </dd>
 </dl>
-The start-up routine <internallink id="onload"><code>Agent_OnLoad</code></internallink>
+For a dynamic shared library agent, the start-up routine
-in the library will be invoked.
+<internallink id="onload"><code>Agent_OnLoad</code></internallink>
+in the library will be invoked. If the agent library is statically linked
+into the executable then the system will attempt to invoke the
+<code>Agent_OnLoad_&lt;agent-lib-name&gt;</code> entry point where
+&lt;agent-lib-name&gt; is the basename of the
+agent. In the above example <code>-agentpath:c:\myLibs\foo.dll=opt1,opt2</code>,
+the system will attempt to find and call the <code>Agent_OnLoad_foo</code> start-up routine.
 <p/>
 Libraries loaded with <code>-agentlib:</code> or <code>-agentpath:</code>
 will be searched for JNI native method implementations to facilitate the
 use of Java programming language code in tools, as is needed for
 <internallink id="bci">bytecode instrumentation</internallink>.
 <intro id="startup" label="Agent Start-Up">
 The VM starts each agent by invoking a start-up function.
 If the agent is started in the <code>OnLoad</code>
 <functionlink id="GetPhase">phase</functionlink> the function
 <internallink id="onload"><code>Agent_OnLoad</code></internallink>
-will be invoked.
+or <internallink id="onload"><code>Agent_OnLoad_L</code></internallink>
+for statically linked agents will be invoked.
 If the agent is started in the live
 <functionlink id="GetPhase">phase</functionlink> the function
 <internallink id="onattach"><code>Agent_OnAttach</code></internallink>
-will be invoked.
+or <internallink id="onattach"><code>Agent_OnAttach_L</code></internallink>
+for statically linked agents will be invoked.
 Exactly one call to a start-up function is made per agent.
 </intro>
 <intro id="onload" label="Agent Start-Up (OnLoad phase)">
 If an agent is started during the <code>OnLoad</code> phase then its
 agent library must export a start-up function with the following prototype:
 <example>
 JNIEXPORT jint JNICALL
 Agent_OnLoad(JavaVM *vm, char *options, void *reserved)</example>
+Or for a statically linked agent named 'L':
+<example>
+JNIEXPORT jint JNICALL
+Agent_OnLoad_L(JavaVM *vm, char *options, void *reserved)</example>
 The VM will start the agent by calling this function.
 It will be called early enough in VM initialization that:
 <ul>
 <li><functionlink id="SetSystemProperty">system properties</functionlink>
 	may be set before they have been used in the start-up of the VM</li>
 <li>no bytecodes have executed</li>
 <li>no classes have been loaded</li>
 <li>no objects have been created</li>
 </ul>
 <p/>
-The VM will call the <code>Agent_OnLoad</code> function with
+The VM will call the <code>Agent_OnLoad</code> or
+<code>Agent_OnLoad_&lt;agent-lib-name&gt;</code> function with
 <i>&lt;options&gt;</i> as the second argument -
 that is, using the command-line option examples,
 <code>"opt1,opt2"</code> will be passed to the <code>char *options</code>
 argument of <code>Agent_OnLoad</code>.
 The <code>options</code> argument is encoded as a
 <internallink id="mUTF">modified UTF-8</internallink> string.
 If <i>=&lt;options&gt;</i> is not specified,
 a zero length string is passed to <code>options</code>.
-The lifespan of the <code>options</code> string is the <code>Agent_OnLoad</code>
+The lifespan of the <code>options</code> string is the
+<code>Agent_OnLoad</code> or <code>Agent_OnLoad_&lt;agent-lib-name&gt;</code>
 call.  If needed beyond this time the string or parts of the string must
 be copied.
 The period between when <code>Agent_OnLoad</code> is called and when it
 returns is called the <i>OnLoad phase</i>.
 Since the VM is not initialized during the OnLoad
 Early startup is also needed so that agents can control the execution
 environment - modifying the file system and system properties to install
 their functionality.
 </rationale>
 <p/>
-The return value from <code>Agent_OnLoad</code> is used to indicate an error.
+The return value from <code>Agent_OnLoad</code> or
+<code>Agent_OnLoad_&lt;agent-lib-name&gt;</code> is used to indicate an error.
 Any value other than zero indicates an error and causes termination of the VM.
 </intro>
 <intro id="onattach" label="Agent Start-Up (Live phase)">
 A VM may support a mechanism that allows agents to be started in the VM during the live
 must export a start-up function
 with the following prototype:
 <example>
 JNIEXPORT jint JNICALL
 Agent_OnAttach(JavaVM* vm, char *options, void *reserved)</example>
+Or for a statically linked agent named 'L':
+<example>
+JNIEXPORT jint JNICALL
+Agent_OnAttach_L(JavaVM* vm, char *options, void *reserved)</example>
 <p/>
 The VM will start the agent by calling this function.
 It will be called in the context of a thread
 that is attached to the VM. The first argument <i>&lt;vm&gt;</i> is the Java VM.
 The <i>&lt;options&gt;</i> argument is the startup options provided to the agent.
 <i>&lt;options&gt;</i> is encoded as a <internallink id="mUTF">modified UTF-8
 </internallink> string.
 If startup options were not provided, a zero length string is passed to
 <code>options</code>. The lifespan of the <code>options</code> string is the
-<code>Agent_OnAttach</code> call.  If needed beyond this time the string or parts of
+<code>Agent_OnAttach</code> or <code>Agent_OnAttach_&lt;agent-lib-name&gt;</code> call.
-the string must be copied.
+If needed beyond this time the string or parts of the string must be copied.
 <p/>
 Note that some <internallink id="capability">capabilities</internallink>
 may not be available in the live phase.
 <p/>
-The <code>Agent_OnAttach</code> function initializes the agent and returns a value
+The <code>Agent_OnAttach</code> or <code>Agent_OnAttach_&lt;agent-lib-name
+&gt;</code> function initializes the agent and returns a value
 to the VM to indicate if an error occurred. Any value other than zero indicates an error.
 An error does not cause the VM to terminate. Instead the VM ignores the error, or takes
 some implementation specific action -- for example it might print an error to standard error,
 or record the error in a system log.
 </intro>
 The library may optionally export a
 shutdown function with the following prototype:
 <example>
 JNIEXPORT void JNICALL
 Agent_OnUnload(JavaVM *vm)</example>
+Or for a statically linked agent named 'L':
+<example>
+JNIEXPORT void JNICALL
+Agent_OnUnload_L(JavaVM *vm)</example>
 This function will be called by the VM when the library is about to be unloaded.
-The library will be unloaded and this function will be called if some platform specific
+The library will be unloaded (unless it is statically linked into the
+executable) and this function will be called if some platform specific
 mechanism causes the unload (an unload mechanism is not specified in this document)
 or the library is (in effect) unloaded by the termination of the VM whether through
 normal termination or VM failure, including start-up failure.
 Uncontrolled shutdown is, of couse, an exception to this rule.
 Note the distinction between this function and the
 <eventlink id="VMDeath">VM Death event</eventlink>: for the VM Death event
 to be sent, the VM must have run at least to the point of initialization and a valid
 <jvmti/> environment must exist which has set a callback for VMDeath
-and enabled the event
+and enabled the event.
-None of these are required for <code>Agent_OnUnload</code> and this function
+None of these are required for <code>Agent_OnUnload</code> or
+<code>Agent_OnUnload_&lt;agent-lib-name&gt;</code> and this function
 is also called if the library is unloaded for other reasons.
 In the case that a VM Death event is sent, it will be sent before this
 function is called (assuming this function is called due to VM termination).
 This function can be used to clean-up resources allocated by the agent.
 </intro>
 Return the current phase of VM execution.
 The phases proceed in sequence:
 <constants id="jvmtiPhase" label="Phases of execution" kind="enum">
 <constant id="JVMTI_PHASE_ONLOAD" num="1">
 <code>OnLoad</code> phase: while in the
-<internallink id="onload"><code>Agent_OnLoad</code></internallink> function.
+<internallink id="onload"><code>Agent_OnLoad</code></internallink>
+or, for statically linked agents, the <internallink id="onload">
+<code>Agent_OnLoad_&lt;agent-lib-name&gt;
+</code></internallink> function.
 </constant>
 <constant id="JVMTI_PHASE_PRIMORDIAL" num="2">
-Primordial phase: between return from <code>Agent_OnLoad</code> and the
+Primordial phase: between return from <code>Agent_OnLoad</code>
+or <code>Agent_OnLoad_&lt;agent-lib-name&gt;</code> and the
 <code>VMStart</code> event.
 </constant>
 <constant id="JVMTI_PHASE_START" num="6">
 Start phase: when the <eventlink id="VMStart"><code>VMStart</code></eventlink> event
 is sent and until the <code>VMInit</code> event is sent.
 Add ResourceExhaustedEvent.
 </change>
 <change date="11 October 2012" version="1.2.2">
 Fixed the "HTTP" and "Missing Anchor" errors reported by the LinkCheck tool.
 </change>
+<change date="19 June 2013" version="1.2.3">
+Added support for statically linked agents.
+</change>
 </changehistory>
 </specification>
 <!-- Keep this comment at the end of the file
 Local variables:

changeset 19553	9bbd930be684
parent 18081	c0a9e6c4058c
child 19973	d98623e1f50b