Skip to content

Commit

Permalink
Generated from commit: 46629e1
Browse files Browse the repository at this point in the history
Signed-off-by: genie-openj9 <[email protected]>
  • Loading branch information
genie-openj9 committed Oct 18, 2024
1 parent 66083fa commit 332affe
Show file tree
Hide file tree
Showing 24 changed files with 392 additions and 392 deletions.
12 changes: 6 additions & 6 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/image/CorruptData.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,16 @@ <h2 title="Interface CorruptData" class="title">Interface CorruptData</h2>
<br>
<pre>public interface <span class="typeNameLabel">CorruptData</span></pre>
<div class="block">This class is used to indicate that corruption has been detected in the image.
It may indicate corruption of the image file, or it may indicate that
It may indicate corruption of the image file, or it may indicate that
inconsistencies have been detected within the image file, perhaps caused by
a bug in the runtime or application.

It may be encountered in two scenarios:
<ul>
<li>within a CorruptDataException</li>
<li>returned as an element from an Iterator</li>
<li>returned as an element from an Iterator</li>
</ul>

Any iterator in DTFJ may implicitly include one or more CorruptData objects
within the list of objects it provides. Normal data may be found after the
CorruptData object if the DTFJ implementation is able to recover from the
Expand Down Expand Up @@ -193,9 +193,9 @@ <h4>toString</h4>
<h4>getAddress</h4>
<pre><a href="../../../../com/ibm/dtfj/image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a>&nbsp;getAddress()</pre>
<div class="block">Return an address associated with the corruption.

If the corruption is not associated with an address, return null.

If the corruption is associated with more than one address, return
the one which best identifies the corruption.</div>
<dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ <h2 title="Interface ImageAddressSpace" class="title">Interface ImageAddressSpac
<br>
<pre>public interface <span class="typeNameLabel">ImageAddressSpace</span></pre>
<div class="block"><p>Represents a single address space within the image.</p>
<p>On some operating systems (e.g. z/OS), there can be more than

<p>On some operating systems (e.g. z/OS), there can be more than
one address space per core file and more than one process per address space.</p></div>
</li>
</ul>
Expand Down Expand Up @@ -199,8 +199,8 @@ <h4>getCurrentProcess</h4>
<div class="block">Get the process within this address space that caused the image to be created.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the process within this address space which caused
the image to be created, if any. Return null if no individual
<dd>the process within this address space which caused
the image to be created, if any. Return null if no individual
process triggered the creation of the image.</dd>
</dl>
</li>
Expand Down
2 changes: 1 addition & 1 deletion api/jdk8/platform/dtfj/com/ibm/dtfj/image/ImageModule.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ <h4>getName</h4>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the file name of the shared library.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - If the module is corrupt and the
<dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - If the module is corrupt and the
original file cannot be determined.</dd>
</dl>
</li>
Expand Down
4 changes: 2 additions & 2 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/image/ImagePointer.html
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ <h4>getAddress</h4>
<div class="block"><p>Get the unwrapped address, represented as a Java long.</p>
<p> Use caution when comparing addresses, as some addresses may be
negative. </p>
<p>Note that, on segmented memory architectures, it may not be
<p>Note that, on segmented memory architectures, it may not be
possible to represent all addresses accurately as integers.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
Expand Down Expand Up @@ -365,7 +365,7 @@ <h4>getPointerAt</h4>
throws <a href="../../../../com/ibm/dtfj/image/MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer. To determine the number of bytes to skip after this
call to read the next value, use <code>ImageProcess.getPointerSize()</code>. Note: to create an
call to read the next value, use <code>ImageProcess.getPointerSize()</code>. Note: to create an
ImagePointer using an absolute address use <code>com.ibm.dtfj.image.ImageAddressSpace.getPointer()</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand Down
20 changes: 10 additions & 10 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/image/ImageProcess.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,14 +191,14 @@ <h3>Method Summary</h3>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/ImageProcess.html#getSignalName--">getSignalName</a></span>()</code>
<div class="block">Get the name of the OS signal in this process which triggered the
<div class="block">Get the name of the OS signal in this process which triggered the
creation of this image.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/ImageProcess.html#getSignalNumber--">getSignalNumber</a></span>()</code>
<div class="block">Get the OS signal number in this process which triggered the creation
<div class="block">Get the OS signal number in this process which triggered the creation
of this image.</div>
</td>
</tr>
Expand Down Expand Up @@ -339,7 +339,7 @@ <h4>getThreads</h4>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator to iterate over each ImageThread in the image

There is not necessarily any relationship between JavaThreads and
ImageThreads. A JVM implementation may use an n:m mapping of JavaThreads to
ImageThreads, and not all ImageThreads are necessarily attached.</dd>
Expand Down Expand Up @@ -380,8 +380,8 @@ <h4>getRuntimes</h4>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator to iterate over all of the known ManagedRuntime
environments in the image.
environments in the image.

In a typical image, there will be only one runtime, and it will be
an instance of JavaRuntime. However any user of this API should be aware
that there is a possibility that other runtimes may exist in the image</dd>
Expand All @@ -401,11 +401,11 @@ <h4>getSignalNumber</h4>
<pre>int&nbsp;getSignalNumber()
throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the OS signal number in this process which triggered the creation
<div class="block">Get the OS signal number in this process which triggered the creation
of this image.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the OS signal number in this process which triggered the creation
<dd>the OS signal number in this process which triggered the creation
of this image, or 0 if the image was not created because of a signal in this
process</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
Expand All @@ -423,12 +423,12 @@ <h4>getSignalName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;getSignalName()
throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the name of the OS signal in this process which triggered the
<div class="block">Get the name of the OS signal in this process which triggered the
creation of this image.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the OS signal in this process which triggered the
creation of this image, or null if the image was not created because of a
<dd>the name of the OS signal in this process which triggered the
creation of this image, or null if the image was not created because of a
signal in this process</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the information cannot be provided</dd>
Expand Down
4 changes: 2 additions & 2 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/image/ImageSection.html
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,9 @@ <h4>getSize</h4>
<h4>getName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Gets the name of this section.

Some memory sections are named. For example, the executable data in a module is typically called ".text".

For memory sections without a specific name, a placeholder string will be returned. This method will never
return null.</div>
<dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h4>getProcedureAddress</h4>
<dd>the address of the current instruction within
the procedure being executed, or null if not available.
<p>
Use this address with caution, as it is provided only
Use this address with caution, as it is provided only
as a best guess. It may not be correct, or even within
readable memory</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
Expand Down Expand Up @@ -214,7 +214,7 @@ <h4>getProcedureName</h4>
<p>
public * <pre>libname(sourcefile)::entrypoint&#177;<!-- +/- -->offset</pre>
<p>
Any portion of the template may be omitted if it is not available
Any portion of the template may be omitted if it is not available
<dl>
<dt>e.g.</dt>
<dd><pre>system32(source.c)::WaitForSingleObject+14</pre></dd>
Expand Down
6 changes: 3 additions & 3 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/image/ImageThread.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ <h4>getStackFrames</h4>
<div class="block">Get the set of stack frames on this thread.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator to walk the native stack frames in order from
<dd>an iterator to walk the native stack frames in order from
top-of-stack (that is, the most recent frame) to bottom-of-stack. Throws
DataUnavailable if native stack frames are not available on this platform.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
Expand Down Expand Up @@ -245,9 +245,9 @@ <h4>getRegisters</h4>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator to iterate over the state of the CPU registers
when the image was created. The collection may be empty if the register
when the image was created. The collection may be empty if the register
state is not available for this thread.

If the CPU supports partial registers (e.g. AH, AL, AX, EAX, RAX on
AMD64), only the largest version of the register will be included</dd>
<dt><span class="seeLabel">See Also:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,14 +272,14 @@ <h3>Uses of <a href="../../../../../com/ibm/dtfj/image/CorruptDataException.html
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><span class="typeNameLabel">ImageProcess.</span><code><span class="memberNameLink"><a href="../../../../../com/ibm/dtfj/image/ImageProcess.html#getSignalName--">getSignalName</a></span>()</code>
<div class="block">Get the name of the OS signal in this process which triggered the
<div class="block">Get the name of the OS signal in this process which triggered the
creation of this image.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><span class="typeNameLabel">ImageProcess.</span><code><span class="memberNameLink"><a href="../../../../../com/ibm/dtfj/image/ImageProcess.html#getSignalNumber--">getSignalNumber</a></span>()</code>
<div class="block">Get the OS signal number in this process which triggered the creation
<div class="block">Get the OS signal number in this process which triggered the creation
of this image.</div>
</td>
</tr>
Expand Down Expand Up @@ -579,7 +579,7 @@ <h3>Uses of <a href="../../../../../com/ibm/dtfj/image/CorruptDataException.html
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><span class="typeNameLabel">JavaMonitor.</span><code><span class="memberNameLink"><a href="../../../../../com/ibm/dtfj/java/JavaMonitor.html#getName--">getName</a></span>()</code>
<div class="block">Note that the name of a JavaMonitor is not necessarily meaningful but is provided here as it is
<div class="block">Note that the name of a JavaMonitor is not necessarily meaningful but is provided here as it is
usually present in the running VM.</div>
</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,14 @@ <h3>Uses of <a href="../../../../../com/ibm/dtfj/image/DataUnavailable.html" tit
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><span class="typeNameLabel">ImageProcess.</span><code><span class="memberNameLink"><a href="../../../../../com/ibm/dtfj/image/ImageProcess.html#getSignalName--">getSignalName</a></span>()</code>
<div class="block">Get the name of the OS signal in this process which triggered the
<div class="block">Get the name of the OS signal in this process which triggered the
creation of this image.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><span class="typeNameLabel">ImageProcess.</span><code><span class="memberNameLink"><a href="../../../../../com/ibm/dtfj/image/ImageProcess.html#getSignalNumber--">getSignalNumber</a></span>()</code>
<div class="block">Get the OS signal number in this process which triggered the creation
<div class="block">Get the OS signal number in this process which triggered the creation
of this image.</div>
</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h2 title="Interface JavaClassLoader" class="title">Interface JavaClassLoader</h
object within with JavaRuntime. For primordial class loaders such as
the bootstrap class loader, there may or may not be a corresponding
<code>java.lang.ClassLoader</code> instance.</p>

<p>Since Java does not define any strict inheritance structure between
class loaders, there are no APIs for inspecting 'child' or 'parent'
class loaders. This information may be inferred by inspecting the
Expand Down
8 changes: 4 additions & 4 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/java/JavaHeap.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,10 @@ <h2 title="Interface JavaHeap" class="title">Interface JavaHeap</h2>
<br>
<pre>public interface <span class="typeNameLabel">JavaHeap</span></pre>
<div class="block"><p>Represents a heap of managed objects.</p>
<p>There may be multiple heaps within a JVM, for instance a generational
heap and a class heap. Additionally, heaps may consist of non-contiguous
memory regions. For instance, an object heap may be divided into a hot

<p>There may be multiple heaps within a JVM, for instance a generational
heap and a class heap. Additionally, heaps may consist of non-contiguous
memory regions. For instance, an object heap may be divided into a hot
and cold section.</p></div>
</li>
</ul>
Expand Down
12 changes: 6 additions & 6 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/java/JavaLocation.html
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,10 @@ <h4>getAddress</h4>
getBytecodeSections() or getCompiledSections() of the method returned by
getMethod().
<p>
null may be returned, particularly for methods with no bytecode or
null may be returned, particularly for methods with no bytecode or
compiled sections (e.g. some native methods)
<p>
Although an offset into the method may be calculated using this
Although an offset into the method may be calculated using this
pointer, caution should be exercised in attempting to map this offset to
an offset within the original class file. Various transformations may
have been applied to the bytecodes by the VM or other agents which may
Expand Down Expand Up @@ -275,10 +275,10 @@ <h4>getFilename</h4>
<h4>getCompilationLevel</h4>
<pre>int&nbsp;getCompilationLevel()
throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the compilation level for this location. This is an implementation
defined number indicating the level at which the current location was
compiled. 0 indicates interpreted. Any positive number indicates some
level of JIT compilation. Typically, higher numbers indicate more
<div class="block">Get the compilation level for this location. This is an implementation
defined number indicating the level at which the current location was
compiled. 0 indicates interpreted. Any positive number indicates some
level of JIT compilation. Typically, higher numbers indicate more
aggressive compilation strategies
<p>
For native methods, a non-zero compilation level indicates that some
Expand Down
2 changes: 1 addition & 1 deletion api/jdk8/platform/dtfj/com/ibm/dtfj/java/JavaMember.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h2 title="Interface JavaMember" class="title">Interface JavaMember</h2>
<br>
<pre>public interface <span class="typeNameLabel">JavaMember</span></pre>
<div class="block"><p>Base interface inherited by JavaField and JavaMethod.</p>

<p>This interface is modeled on java.lang.reflect.Member.</p></div>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion api/jdk8/platform/dtfj/com/ibm/dtfj/java/JavaMethod.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ <h4>getBytecodeSections</h4>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator over a collection of ImageSections.
Each ImageSection contains data (usually bytecodes) used
in executing this method in interpreted mode.
in executing this method in interpreted mode.
<p>
The collection may be empty for native methods, or
pre-compiled methods.
Expand Down
4 changes: 2 additions & 2 deletions api/jdk8/platform/dtfj/com/ibm/dtfj/java/JavaMonitor.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h3>Method Summary</h3>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaMonitor.html#getName--">getName</a></span>()</code>
<div class="block">Note that the name of a JavaMonitor is not necessarily meaningful but is provided here as it is
<div class="block">Note that the name of a JavaMonitor is not necessarily meaningful but is provided here as it is
usually present in the running VM.</div>
</td>
</tr>
Expand Down Expand Up @@ -218,7 +218,7 @@ <h4>getObject</h4>
<h4>getName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;getName()
throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Note that the name of a JavaMonitor is not necessarily meaningful but is provided here as it is
<div class="block">Note that the name of a JavaMonitor is not necessarily meaningful but is provided here as it is
usually present in the running VM. If there is no name for the monitor a synthetic name will be
created by DTFJ.</div>
<dl>
Expand Down
Loading

0 comments on commit 332affe

Please sign in to comment.