jmap.1 revision 5176
55cf6e01272ec475edea32aa9b7923de2d36cb42Christian Maeder." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e9458b1a7a19a63aa4c179f9ab20f4d50681c168Jens Elkner."
e1f395fef7ea8b00a675a330e5461fad35158ca5Christian Maeder." This code is free software; you can redistribute it and/or modify it
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski." under the terms of the GNU General Public License version 2 only, as
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu." published by the Free Software Foundation.
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski."
3f69b6948966979163bdfe8331c38833d5d90ecdChristian Maeder." This code is distributed in the hope that it will be useful, but WITHOUT
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maeder." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski." version 2 for more details (a copy is included in the LICENSE file that
f3a94a197960e548ecd6520bb768cb0d547457bbChristian Maeder." accompanied this code).
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski."
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski." You should have received a copy of the GNU General Public License version
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski." 2 along with this work; if not, write to the Free Software Foundation,
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
729aff22a7983f5bb113dcc604157edd728c1484Christian Maeder."
d3c9318c22fcf44d9135a3b2c64f880b9a785babChristian Maeder." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
d3c9318c22fcf44d9135a3b2c64f880b9a785babChristian Maeder." or visit www.oracle.com if you need additional information or have any
729aff22a7983f5bb113dcc604157edd728c1484Christian Maeder." questions.
1361b09b79b95d47e03eba7a1fc9eddc39aa0455Christian Maeder."
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder.TH jmap 1 "10 May 2011"
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski
31c49f2fa23d4ac089f35145d80a224deb6ea7e4Till Mossakowski.LP
aa0ef8adb2833838c1954e6f93c61d85d2cb226aTill Mossakowski.SH "Name"
aa0ef8adb2833838c1954e6f93c61d85d2cb226aTill Mossakowskijmap \- Memory Map
a5e231ee4359da4667d54016848220c590a77b79Paolo Torrini.LP
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski.SH "SYNOPSIS"
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder.LP
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder.nf
d3c9318c22fcf44d9135a3b2c64f880b9a785babChristian Maeder\f3
d3c9318c22fcf44d9135a3b2c64f880b9a785babChristian Maeder.fl
05ca76b03b6d16bcfb3e7654c31e41a220e85663Till Mossakowski\fP\f3jmap\fP [ option ] pid
8d97ef4f234681b11bb5924bd4d03adef858d2d2Christian Maeder.fl
602041e384342ea908c976a298e8b47774d3500cTill Mossakowski\f3jmap\fP [ option ] executable core
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maeder.fl
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maeder\f3jmap\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
8d97ef4f234681b11bb5924bd4d03adef858d2d2Christian Maeder.fl
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maeder.fi
31c49f2fa23d4ac089f35145d80a224deb6ea7e4Till Mossakowski
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski.LP
a65c6747c9acbbebc93baba7bae94d2e3d8cdafbTill Mossakowski.SH "PARAMETERS"
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maeder.LP
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maeder.RS 3
d3c9318c22fcf44d9135a3b2c64f880b9a785babChristian Maeder.TP 3
d3c9318c22fcf44d9135a3b2c64f880b9a785babChristian Maederoption
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von SchroederOptions are mutually exclusive. Option, if used, should follow immediately after the command name.
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder.TP 3
c438c79d00fc438f99627e612498744bdc0d0c89Christian Maederpid
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maederprocess id for which the memory map is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used.
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski.br
e1f395fef7ea8b00a675a330e5461fad35158ca5Christian Maeder.TP 3
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowskiexecutable
8d97ef4f234681b11bb5924bd4d03adef858d2d2Christian MaederJava executable from which the core dump was produced.
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder.br
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski.TP 3
a7be28e157e9ceeec73a8fd0e642c36ea29d4218Christian Maedercore
a7be28e157e9ceeec73a8fd0e642c36ea29d4218Christian Maedercore file for which the memory map is to be printed.
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski.br
72186e215ea8bd54f41bde5b792652aa7ca42167Till Mossakowski.TP 3
8d97ef4f234681b11bb5924bd4d03adef858d2d2Christian Maederremote\-hostname\-or\-IP
b65e16b9e5652ff341ab0f49be5da51e2c0e10a5Till Mossakowskiremote debug server's (see jsadebugd(1)) hostname or IP address.
b65e16b9e5652ff341ab0f49be5da51e2c0e10a5Till Mossakowski.br
6b8f813c46b719a37e9a61cdfba85339952abbedChristian Maeder.TP 3
cd6e5706893519bfcf24539afa252fcbed5097ddKlaus Luettichserver\-id
eb9c04f9cff47a81f6d362ca03fbf4cb7ab97e7ccmaederoptional unique id, if multiple debug servers are running on the same remote host.
eb9c04f9cff47a81f6d362ca03fbf4cb7ab97e7ccmaeder.br
cd6e5706893519bfcf24539afa252fcbed5097ddKlaus Luettich.RE
dd6f22b9dcff2695181b86372e4df03d5b96e92dKristina Sojakova
eb9c04f9cff47a81f6d362ca03fbf4cb7ab97e7ccmaeder.LP
eb9c04f9cff47a81f6d362ca03fbf4cb7ab97e7ccmaeder.SH "DESCRIPTION"
.LP
.LP
\f3jmap\fP prints shared object memory maps or heap memory details of a given process or core file or a remote debug server. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
.LP
.nf
\f3
.fl
jmap \-J\-d64 \-heap pid
.fl
\fP
.fi
.LP
.LP
\f3NOTE: This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
.LP
.LP
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
.br
.LP
.SH "OPTIONS"
.LP
.RS 3
.TP 3
<no option>
When no option is used jmap prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility.
.br
.TP 3
\-dump:[live,]format=b,file=<filename>
Dumps the Java heap in hprof binary format to filename. The \f2live\fP suboption is optional. If specified, only the live objects in the heap are dumped. To browse the heap dump, you can use jhat(1) (Java Heap Analysis Tool) to read the generated file.
.br
.TP 3
\-finalizerinfo
Prints information on objects awaiting finalization.
.br
.TP 3
\-heap
Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed.
.br
.TP 3
\-histo[:live]
Prints a histogram of the heap. For each Java class, number of objects, memory size in bytes, and fully qualified class names are printed. VM internal class names are printed with '*' prefix. If the \f2live\fP suboption is specified, only live objects are counted.
.br
.TP 3
\-permstat
Prints class loader wise statistics of permanent generation of Java heap. For each class loader, its name, liveness, address, parent class loader, and the number and size of classes it has loaded are printed. In addition, the number and size of interned Strings are printed.
.br
.TP 3
\-F
Force. Use with jmap \-dump or jmap \-histo option if the pid does not respond. The \f2live\fP suboption is not supported in this mode.
.br
.TP 3
\-h
Prints a help message.
.br
.br
.TP 3
\-help
Prints a help message.
.br
.br
.TP 3
\-J<flag>
Passes <flag> to the Java virtual machine on which jmap is run.
.br
.RE
.LP
.SH "SEE ALSO"
.LP
.RS 3
.TP 2
o
pmap(1)
.TP 2
o
jhat(1)
.TP 2
o
jps(1)
.TP 2
o
jsadebugd(1)
.RE
.LP