8228494: Update nroff version of man pages
Reviewed-by: mchung
This commit is contained in:
Jonathan Gibbons
parent
6e90474edf
commit
5fc206ea7d
@ -1868,17 +1868,21 @@ By default, this option is enabled.
|
||||
.TP
|
||||
.B \f[CB]\-XX:\-UseCompressedOops\f[R]
|
||||
Disables the use of compressed pointers.
|
||||
By default, this option is enabled, and compressed pointers are used
|
||||
when Java heap sizes are less than 32 GB.
|
||||
When this option is enabled, object references are represented as
|
||||
32\-bit offsets instead of 64\-bit pointers, which typically increases
|
||||
performance when running the application with Java heap sizes of less
|
||||
than 32 GB.
|
||||
This option works only for 64\-bit JVMs.
|
||||
By default, this option is enabled, and compressed pointers are used.
|
||||
This will automatically limit the maximum ergonomically determined Java
|
||||
heap size to the maximum amount of memory that can be covered by
|
||||
compressed pointers.
|
||||
By default this range is 32 GB.
|
||||
.RS
|
||||
.PP
|
||||
It\[aq]s also possible to use compressed pointers when Java heap sizes
|
||||
are greater than 32 GB.
|
||||
With compressed oops enabled, object references are represented as
|
||||
32\-bit offsets instead of 64\-bit pointers, which typically increases
|
||||
performance when running the application with Java heap sizes smaller
|
||||
than the compressed oops pointer range.
|
||||
This option works only for 64\-bit JVMs.
|
||||
.PP
|
||||
It\[aq]s possible to use compressed pointers with Java heap sizes
|
||||
greater than 32 GB.
|
||||
See the \f[CB]\-XX:ObjectAlignmentInBytes\f[R] option.
|
||||
.RE
|
||||
.TP
|
||||
@ -3213,6 +3217,22 @@ The size of the heap for the young generation can be set using the
|
||||
\f[CB]\-XX:NewSize\f[R] option.
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:InitialRAMPercentage=\f[R]\f[I]percent\f[R]
|
||||
Sets the initial amount of memory that the JVM will use for the Java
|
||||
heap before applying ergonomics heuristics as a percentage of the
|
||||
maximum amount determined as described in the \f[CB]\-XX:MaxRAM\f[R]
|
||||
option.
|
||||
The default value is 1.5625 percent.
|
||||
.RS
|
||||
.PP
|
||||
The following example shows how to set the percentage of the initial
|
||||
amount of memory used for the Java heap:
|
||||
.RS
|
||||
.PP
|
||||
\f[CB]\-XX:InitialRAMPercentage=5\f[R]
|
||||
.RE
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:InitialSurvivorRatio=\f[R]\f[I]ratio\f[R]
|
||||
Sets the initial survivor space ratio used by the throughput garbage
|
||||
collector (which is enabled by the \f[CB]\-XX:+UseParallelGC\f[R] and/or
|
||||
@ -3371,6 +3391,72 @@ The default value is set ergonomically.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:MaxRAM=\f[R]\f[I]size\f[R]
|
||||
Sets the maximum amount of memory that the JVM may use for the Java heap
|
||||
before applying ergonomics heuristics.
|
||||
The default value is the maximum amount of available memory to the JVM
|
||||
process or 128 GB, whichever is lower.
|
||||
.RS
|
||||
.PP
|
||||
The maximum amount of available memory to the JVM process is the minimum
|
||||
of the machine\[aq]s physical memory and any constraints set by the
|
||||
environment (e.g.
|
||||
container).
|
||||
.PP
|
||||
Specifying this option disables automatic use of compressed oops if the
|
||||
combined result of this and other options influencing the maximum amount
|
||||
of memory is larger than the range of memory addressable by compressed
|
||||
oops.
|
||||
See \f[CB]\-XX:UseCompressedOops\f[R] for further information about
|
||||
compressed oops.
|
||||
.PP
|
||||
The following example shows how to set the maximum amount of available
|
||||
memory for sizing the Java heap to 2 GB:
|
||||
.RS
|
||||
.PP
|
||||
\f[CB]\-XX:MaxRAM=2G\f[R]
|
||||
.RE
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:MaxRAMPercentage=\f[R]\f[I]percent\f[R]
|
||||
Sets the maximum amount of memory that the JVM may use for the Java heap
|
||||
before applying ergonomics heuristics as a percentage of the maximum
|
||||
amount determined as described in the \f[CB]\-XX:MaxRAM\f[R] option.
|
||||
The default value is 25 percent.
|
||||
.RS
|
||||
.PP
|
||||
Specifying this option disables automatic use of compressed oops if the
|
||||
combined result of this and other options influencing the maximum amount
|
||||
of memory is larger than the range of memory addressable by compressed
|
||||
oops.
|
||||
See \f[CB]\-XX:UseCompressedOops\f[R] for further information about
|
||||
compressed oops.
|
||||
.PP
|
||||
The following example shows how to set the percentage of the maximum
|
||||
amount of memory used for the Java heap:
|
||||
.RS
|
||||
.PP
|
||||
\f[CB]\-XX:MaxRAMPercentage=75\f[R]
|
||||
.RE
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:MinRAMPercentage=\f[R]\f[I]percent\f[R]
|
||||
Sets the maximum amount of memory that the JVM may use for the Java heap
|
||||
before applying ergonomics heuristics as a percentage of the maximum
|
||||
amount determined as described in the \f[CB]\-XX:MaxRAM\f[R] option for
|
||||
small heaps.
|
||||
A small heap is a heap of approximately 125 MB.
|
||||
The default value is 50 percent.
|
||||
.RS
|
||||
.PP
|
||||
The following example shows how to set the percentage of the maximum
|
||||
amount of memory used for the Java heap for small heaps:
|
||||
.RS
|
||||
.PP
|
||||
\f[CB]\-XX:MinRAMPercentage=75\f[R]
|
||||
.RE
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:MaxTenuringThreshold=\f[R]\f[I]threshold\f[R]
|
||||
Sets the maximum tenuring threshold for use in adaptive GC sizing.
|
||||
The largest value is 15.
|
||||
@ -3802,6 +3888,45 @@ Since JDK 8u40 this option has not been required to use JFR.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:InitialRAMFraction=\f[R]\f[I]ratio\f[R]
|
||||
Sets the initial amount of memory that the JVM may use for the Java heap
|
||||
before applying ergonomics heuristics as a ratio of the maximum amount
|
||||
determined as described in the \f[CB]\-XX:MaxRAM\f[R] option.
|
||||
The default value is 64.
|
||||
.RS
|
||||
.PP
|
||||
Use the option \f[CB]\-XX:InitialRAMPercentage\f[R] instead.
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:MaxRAMFraction=\f[R]\f[I]ratio\f[R]
|
||||
Sets the maximum amount of memory that the JVM may use for the Java heap
|
||||
before applying ergonomics heuristics as a fraction of the maximum
|
||||
amount determined as described in the \f[CB]\-XX:MaxRAM\f[R] option.
|
||||
The default value is 4.
|
||||
.RS
|
||||
.PP
|
||||
Specifying this option disables automatic use of compressed oops if the
|
||||
combined result of this and other options influencing the maximum amount
|
||||
of memory is larger than the range of memory addressable by compressed
|
||||
oops.
|
||||
See \f[CB]\-XX:UseCompressedOops\f[R] for further information about
|
||||
compressed oops.
|
||||
.PP
|
||||
Use the option \f[CB]\-XX:MaxRAMPercentage\f[R] instead.
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:MinRAMFraction=\f[R]\f[I]ratio\f[R]
|
||||
Sets the maximum amount of memory that the JVM may use for the Java heap
|
||||
before applying ergonomics heuristics as a fraction of the maximum
|
||||
amount determined as described in the \f[CB]\-XX:MaxRAM\f[R] option for
|
||||
small heaps.
|
||||
A small heap is a heap of approximately 125 MB.
|
||||
The default value is 2.
|
||||
.RS
|
||||
.PP
|
||||
Use the option \f[CB]\-XX:MinRAMPercentage\f[R] instead.
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-XX:+TraceClassLoading\f[R]
|
||||
Enables tracing of classes as they are loaded.
|
||||
By default, this option is disabled and classes aren\[aq]t traced.
|
||||
|
||||
295
src/java.base/share/man/jfr.1
Normal file
295
src/java.base/share/man/jfr.1
Normal file
@ -0,0 +1,295 @@
|
||||
.\" Copyright (c) 1994, 2019, 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.
|
||||
.\"
|
||||
.\" This code is distributed in the hope that it will be useful, but WITHOUT
|
||||
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
.\" version 2 for more details (a copy is included in the LICENSE file that
|
||||
.\" accompanied this code).
|
||||
.\"
|
||||
.\" You should have received a copy of the GNU General Public License version
|
||||
.\" 2 along with this work; if not, write to the Free Software Foundation,
|
||||
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
.\"
|
||||
.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
||||
.\" or visit www.oracle.com if you need additional information or have any
|
||||
.\" questions.
|
||||
.\"
|
||||
.\" Automatically generated by Pandoc 2.3.1
|
||||
.\"
|
||||
.TH "JFR" "1" "2019" "JDK 13" "JDK Commands"
|
||||
.hy
|
||||
.SH NAME
|
||||
.PP
|
||||
jfr \- parse and print Flight Recorder files
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
To print the contents of a flight recording to standard out:
|
||||
.PP
|
||||
\f[CB]jfr\f[R] \f[CB]print\f[R] [\f[I]options\f[R]] \f[I]file\f[R]
|
||||
.PP
|
||||
To print metadata information about flight recording events:
|
||||
.PP
|
||||
\f[CB]jfr\f[R] \f[CB]metadata\f[R] \f[I]file\f[R]
|
||||
.PP
|
||||
To assemble chunk files into a flight recording file:
|
||||
.PP
|
||||
\f[CB]jfr\f[R] \f[CB]assemble\f[R] \f[I]repository\f[R] \f[I]file\f[R]
|
||||
.PP
|
||||
To disassemble a flight recording file into chunk files:
|
||||
.PP
|
||||
\f[CB]jfr\f[R] \f[CB]disassmble\f[R] [\f[I]options\f[R]] \f[I]file\f[R]
|
||||
.PP
|
||||
To view the summary statistics for a flight recording file:
|
||||
.PP
|
||||
\f[CB]jfr\f[R] \f[CB]summary\f[R] \f[I]file\f[R]
|
||||
.TP
|
||||
.B \f[I]options\f[R]
|
||||
Optional: Specifies command\-line options separated by spaces.
|
||||
See the individual subcomponent sections for descriptions of the
|
||||
available options.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[I]file\f[R]
|
||||
Specifies the name of the target flight recording file
|
||||
(\f[CB]\&.jfr\f[R]).
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[I]repository\f[R]
|
||||
Specifies the location of the chunk files which are to be assembled into
|
||||
a flight recording.
|
||||
.RS
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \f[CB]jfr\f[R] command provides a tool for interacting with flight
|
||||
recorder files (\f[CB]\&.jfr\f[R]).
|
||||
The main function is to filter, summarize and output flight recording
|
||||
files into human readable format.
|
||||
There is also support for merging and splitting recording files.
|
||||
.PP
|
||||
Flight recording files are created and saved as binary formatted files.
|
||||
Having a tool that can extract the contents from a flight recording and
|
||||
manipulate the contents and translate them into human readable format
|
||||
helps developers to debug performance issues with Java applications.
|
||||
.SS Subcommands
|
||||
.PP
|
||||
The \f[CB]jfr\f[R] command has several subcommands:
|
||||
.IP \[bu] 2
|
||||
\f[CB]print\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]summary\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]assemble\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]disassemble\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]metadata\f[R]
|
||||
.SS \f[CB]jfr\ print\f[R] subcommand
|
||||
.PP
|
||||
Use \f[CB]jfr\ print\f[R] to print the contents of a flight recording file
|
||||
to standard out.
|
||||
The syntax is:
|
||||
.PP
|
||||
\f[CB]jfr\ print\f[R] [\f[CB]\-\-xml\f[R]|\f[CB]\-\-json\f[R]]
|
||||
[\f[CB]\-\-categories\f[R] <\f[I]filters\f[R]>] [\f[CB]\-\-events\f[R]
|
||||
<\f[I]filters\f[R]>] [\f[CB]\-\-stack\-depth\f[R] <\f[I]depth\f[R]>]
|
||||
<\f[I]file\f[R]>
|
||||
.PP
|
||||
where:
|
||||
.TP
|
||||
.B \f[CB]\-\-xml\f[R]
|
||||
Print the recording in XML format
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-json\f[R]
|
||||
Print the recording in JSON format
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-categories\f[R] <\f[I]filters\f[R]>
|
||||
Select events matching a category name.
|
||||
The filter is a comma\-separated list of names, simple and/or qualified,
|
||||
and/or quoted glob patterns
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-events\f[R] <\f[I]filters\f[R]>
|
||||
Select events matching an event name.
|
||||
The filter is a comma\-separated list of names, simple and/or qualified,
|
||||
and/or quoted glob patterns
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-stack\-depth\f[R] <\f[I]depth\f[R]>
|
||||
Number of frames in stack traces, by default 5
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B <\f[I]file\f[R]>
|
||||
Location of the recording file (\f[CB]\&.jfr\f[R])
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
The default format for printing the contents of the flight recording
|
||||
file is human readable form unless either \f[CB]xml\f[R] or \f[CB]json\f[R]
|
||||
is specified.
|
||||
These options provide machine\-readable output that can be further
|
||||
parsed or processed by user created scripts.
|
||||
.PP
|
||||
Use \f[CB]jfr\ \-\-help\ print\f[R] to see example usage of filters.
|
||||
.PP
|
||||
To reduce the amount of data displayed, it is possible to filter out
|
||||
events or categories of events.
|
||||
The filter operates on the symbolic name of an event, set by using the
|
||||
\f[CB]\@Name\f[R] annotation, or the category name, set by using the
|
||||
\f[CB]\@Category\f[R] annotation.
|
||||
If multiple filters are used, events from both filters will be included.
|
||||
If no filter is used, all the events will be printed.
|
||||
If a combination of a category filter and event filter is used, the
|
||||
selected events will be the union of the two filters.
|
||||
.PP
|
||||
For example, to show all GC events and the CPULoad event, the following
|
||||
command could be used:
|
||||
.PP
|
||||
\f[CB]jfr\ print\ \-\-categories\ GC\ \-\-events\ CPULoad\ recording.jfr\f[R]
|
||||
.PP
|
||||
Event values are formatted according to the content types that are being
|
||||
used.
|
||||
For example, a field with the \f[CB]jdk.jfr.Percentage\f[R] annotation
|
||||
that has the value 0.52 is formatted as 52%.
|
||||
.PP
|
||||
Stack traces are by default truncated to 5 frames, but the number can be
|
||||
increased/decreased using the \f[CB]\-\-stack\-depth\f[R] command\-line
|
||||
option.
|
||||
.SS \f[CB]jfr\ summary\f[R] subcommand
|
||||
.PP
|
||||
Use \f[CB]jfr\ summary\f[R] to print statistics for a recording.
|
||||
For example, a summary can illustrate the number of recorded events and
|
||||
how much disk space they used.
|
||||
This is useful for troubleshooting and understanding the impact of event
|
||||
settings.
|
||||
.PP
|
||||
The syntax is:
|
||||
.PP
|
||||
\f[CB]jfr\ summary\f[R] <\f[I]file\f[R]>
|
||||
.PP
|
||||
where:
|
||||
.TP
|
||||
.B <\f[I]file\f[R]>
|
||||
Location of the flight recording file (\f[CB]\&.jfr\f[R])
|
||||
.RS
|
||||
.RE
|
||||
.SS \f[CB]jfr\ metadata\f[R] subcommand
|
||||
.PP
|
||||
Use \f[CB]jfr\ metadata\f[R] to view information about events, such as
|
||||
event names, categories and field layout within a flight recording file.
|
||||
The syntax is:
|
||||
.PP
|
||||
\f[CB]jfr\ metadata\f[R] <\f[I]file\f[R]>
|
||||
.PP
|
||||
where:
|
||||
.TP
|
||||
.B <\f[I]file\f[R]>
|
||||
Location of the flight recording file (\f[CB]\&.jfr\f[R])
|
||||
.RS
|
||||
.RE
|
||||
.SS jfr \f[CB]assemble\f[R] subcommand
|
||||
.PP
|
||||
Use jfr \f[CB]assemble\f[R] to assemble chunk files into a recording file.
|
||||
.PP
|
||||
The syntax is:
|
||||
.PP
|
||||
\f[CB]jfr\ assemble\f[R] <\f[I]repository\f[R]> <\f[I]file\f[R]>
|
||||
.PP
|
||||
where:
|
||||
.TP
|
||||
.B <\f[I]repository\f[R]>
|
||||
Directory where the repository containing chunk files is located
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B <\f[I]file\f[R]>
|
||||
Location of the flight recording file (\f[CB]\&.jfr\f[R])
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
Flight recording information is written in chunks.
|
||||
A chunk contains all of the information necessary for parsing.
|
||||
A chunk typically contains events useful for troubleshooting.
|
||||
If a JVM should crash, these chunks can be recovered and used to create
|
||||
a flight recording file using this \f[CB]jfr\ assemble\f[R] command.
|
||||
These chunk files are concatenated in chronological order and chunk
|
||||
files that are not finished (.part) are excluded.
|
||||
.SS \f[CB]jfr\ disassemble\f[R] subcommand
|
||||
.PP
|
||||
Use \f[CB]jfr\ disassemble\f[R] to decompose a flight recording file into
|
||||
its chunk file pieces.
|
||||
The syntax is:
|
||||
.PP
|
||||
\f[CB]jfr\ disassemble\f[R] [\f[CB]\-\-max\-chunks\f[R] <\f[I]chunks\f[R]>]
|
||||
[\f[CB]\-\-output\f[R] <\f[I]directory\f[R]>] <\f[I]file\f[R]>
|
||||
.PP
|
||||
where:
|
||||
.TP
|
||||
.B \f[CB]\-\-output\f[R] <\f[I]directory\f[R]>
|
||||
The location to write the disassembled file, by default the current
|
||||
directory
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-max\-chunks\f[R] <\f[I]chunks\f[R]>
|
||||
Maximum number of chunks per file, by default 5.
|
||||
The chunk size varies, but is typically around 15 MB.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-max\-size\f[R] <\f[I]size\f[R]>
|
||||
Maximum number of bytes per file.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B <\f[I]file\f[R]>
|
||||
Location of the flight recording file (\f[CB]\&.jfr\f[R])
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
This function can be useful for repairing a broken file by removing the
|
||||
faulty chunk.
|
||||
It can also be used to reduce the size of a file that is too large to
|
||||
transfer.
|
||||
The resulting chunk files are named \f[CB]myfile_1.jfr\f[R],
|
||||
\f[CB]myfile_2.jfr\f[R], etc.
|
||||
If needed, the resulting file names will be padded with zeros to
|
||||
preserve chronological order.
|
||||
For example, the chunk file name is \f[CB]myfile_001.jfr\f[R] if the
|
||||
recording consists of more than 100 chunks.
|
||||
.SS jfr version and help subcommands
|
||||
.PP
|
||||
Use \f[CB]jfr\ \-\-version\f[R] or \f[CB]jfr\ version\f[R] to view the
|
||||
version string information for this jfr command.
|
||||
.PP
|
||||
To get help on any of the jfr subcommands, use:
|
||||
.PP
|
||||
\f[CB]jfr\ <\-\-help|help>\f[R] [\f[I]subcommand\f[R]]
|
||||
.PP
|
||||
where:
|
||||
.PP
|
||||
[\f[I]subcommand\f[R]] is any of:
|
||||
.IP \[bu] 2
|
||||
\f[CB]print\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]metadata\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]summary\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]assemble\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[CB]disassemble\f[R]
|
||||
209
src/jdk.aot/share/man/jaotc.1
Normal file
209
src/jdk.aot/share/man/jaotc.1
Normal file
@ -0,0 +1,209 @@
|
||||
.\" Copyright (c) 1994, 2019, 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.
|
||||
.\"
|
||||
.\" This code is distributed in the hope that it will be useful, but WITHOUT
|
||||
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
.\" version 2 for more details (a copy is included in the LICENSE file that
|
||||
.\" accompanied this code).
|
||||
.\"
|
||||
.\" You should have received a copy of the GNU General Public License version
|
||||
.\" 2 along with this work; if not, write to the Free Software Foundation,
|
||||
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
.\"
|
||||
.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
||||
.\" or visit www.oracle.com if you need additional information or have any
|
||||
.\" questions.
|
||||
.\"
|
||||
.\" Automatically generated by Pandoc 2.3.1
|
||||
.\"
|
||||
.TH "JAOTC" "1" "2019" "JDK 13" "JDK Commands"
|
||||
.hy
|
||||
.SH NAME
|
||||
.PP
|
||||
jaotc \- The Java static compiler that produces native code for compiled
|
||||
Java methods
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[CB]jaotc\f[R] [\f[I]options\f[R]] [\f[I]name\f[R] | \f[I]list\f[R]]
|
||||
.TP
|
||||
.B \f[I]options\f[R]
|
||||
Command\-line options separated by spaces.
|
||||
See \f[B]jaotc Options\f[R].
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[I]name\f[R]
|
||||
The Java class or jar file from which Java methods will be compiled.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[I]list\f[R]
|
||||
Colon (\f[CB]:\f[R]) separated list of class names, modules, jar files or
|
||||
directories which contain class files.
|
||||
.RS
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \f[CB]jaotc\f[R] command is a Java Ahead\-Of\-Time (AOT) static
|
||||
compiler which produces native code in the form of a shared library for
|
||||
the Java methods in specified Java class files.
|
||||
The Java Virtual Machine can load these AOT libraries and use native
|
||||
code from them when corresponding Java methods are called.
|
||||
By using \f[CB]jaotc\f[R], there is no need to wait for the JIT compiler
|
||||
to generate (by compiling bytecode) the fast native code for these Java
|
||||
methods.
|
||||
The code is already generated by \f[CB]jaotc\f[R] and ready to be
|
||||
immediately used.
|
||||
For the same reason, there is no need to execute these methods in the
|
||||
Interpreter because fast compiled native code can be executed instead.
|
||||
.PP
|
||||
\f[B]Note:\f[R]
|
||||
.PP
|
||||
The \f[CB]jaotc\f[R] command is experimental.
|
||||
See \f[B]JEP 295: Ahead\-of\-Time Compilation\f[R]
|
||||
[https://openjdk.java.net/jeps/295] for complete details.
|
||||
.SH JAOTC OPTIONS
|
||||
.TP
|
||||
.B \f[CB]\-\-output\f[R] \f[I]file\f[R]
|
||||
Output file name.
|
||||
Default name is "unnamed.so".
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-class\-name\f[R] \f[I]class\-names\f[R]
|
||||
List of Java classes to compile.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-jar\f[R] \f[I]jar\-files\f[R]
|
||||
List of JAR files to compile.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-module\f[R] \f[I]modules\f[R]
|
||||
List of Java modules to compile.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-directory\f[R] \f[I]dirs\f[R]
|
||||
List of directories to search for files to compile.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-search\-path\f[R] \f[I]dirs\f[R]
|
||||
List of directories to search for specified files.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-compile\-commands\f[R] \f[I]file\f[R]
|
||||
Name of the file containing the compile commands:
|
||||
.RS
|
||||
.TP
|
||||
.B \f[CB]exclude\f[R]
|
||||
Excludes compilation of specified methods.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]compileOnly\f[R]
|
||||
Compiles only specified methods.
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
Regular expressions are used to specify classes and methods.
|
||||
For example:
|
||||
.IP
|
||||
.nf
|
||||
\f[CB]
|
||||
exclude\ sun.util.resources..*.TimeZoneNames_.*.getContents\\(\\)\\[\\[Ljava/lang/Object;\
|
||||
exclude\ sun.security.ssl.*\
|
||||
compileOnly\ java.lang.String.*
|
||||
\f[R]
|
||||
.fi
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-compile\-for\-tiered\f[R]
|
||||
Generates profiling code for tiered compilation.
|
||||
By default, profiling code is not generated (could be changed in a
|
||||
future).
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-compile\-with\-assertions\f[R]
|
||||
Generates code with java assertions.
|
||||
By default, assertions code is not generated.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-compile\-threads\f[R] \f[I]number\f[R]
|
||||
Sets the number of compilation threads used.
|
||||
The default value is \f[CB]min(16,\ available_cpus)\f[R].
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-ignore\-errors\f[R]
|
||||
Ignores all exceptions thrown during class loading.
|
||||
By default, the tool will exit compilation if class loading throws an
|
||||
exception.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-exit\-on\-error\f[R]
|
||||
Exits on compilation errors.
|
||||
By default, failed compilation is skipped and compilation of other
|
||||
methods continues.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-info\f[R]
|
||||
Prints information about compilation phases.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-verbose\f[R]
|
||||
Prints more details about compilation phases.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-debug\f[R]
|
||||
Prints comprehensive details.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-help\f[R] or \f[CB]\-h\f[R] or \f[CB]\-?\f[R]
|
||||
Prints a summary of standard options and exits the tool.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-\-version\f[R]
|
||||
Prints version information.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[CB]\-J\f[R]\f[I]flag\f[R]
|
||||
Provides a flag to pass to the runtime system.
|
||||
To pass more than one flag, provide an instance of this option for each
|
||||
flag or flag argument needed.
|
||||
.RS
|
||||
.RE
|
||||
.SH JAOTC EXAMPLES
|
||||
.PP
|
||||
Use the \f[CB]jaotc\f[R] tool to execute AOT compilation.
|
||||
.IP
|
||||
.nf
|
||||
\f[CB]
|
||||
jaotc\ \-\-output\ libHelloWorld.so\ HelloWorld.class
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Specify a generated AOT library during application execution:
|
||||
.IP
|
||||
.nf
|
||||
\f[CB]
|
||||
java\ \-XX:AOTLibrary=./libHelloWorld.so\ HelloWorld
|
||||
\f[R]
|
||||
.fi
|
||||
@ -89,7 +89,7 @@ subdirectories, or to pass in an explicit list of package names.
|
||||
When you document individual source files, pass in a list of Java source
|
||||
file names.
|
||||
See \f[B]javadoc Overview\f[R]
|
||||
[https://www.oracle.com/pls/topic/lookup?ctx=en/java/javase/11/tools&id=JSJAV\-GUID\-7A344353\-3BBF\-45C4\-8B28\-15025DDCC643]
|
||||
[https://www.oracle.com/pls/topic/lookup?ctx=en/java/javase/13/tools&id=JSJAV\-GUID\-7A344353\-3BBF\-45C4\-8B28\-15025DDCC643]
|
||||
in Java Platform, Standard Edition Javadoc Guide for information about
|
||||
using the \f[CB]javadoc\f[R] tool.
|
||||
.SH CONFORMANCE
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user