|
1 '\" t |
|
2 .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. |
|
3 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 .\" |
|
5 .\" This code is free software; you can redistribute it and/or modify it |
|
6 .\" under the terms of the GNU General Public License version 2 only, as |
|
7 .\" published by the Free Software Foundation. |
|
8 .\" |
|
9 .\" This code is distributed in the hope that it will be useful, but WITHOUT |
|
10 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
11 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
12 .\" version 2 for more details (a copy is included in the LICENSE file that |
|
13 .\" accompanied this code). |
|
14 .\" |
|
15 .\" You should have received a copy of the GNU General Public License version |
|
16 .\" 2 along with this work; if not, write to the Free Software Foundation, |
|
17 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
18 .\" |
|
19 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
20 .\" or visit www.oracle.com if you need additional information or have any |
|
21 .\" questions. |
|
22 .\" |
|
23 .\" Arch: generic |
|
24 .\" Software: JDK 8 |
|
25 .\" Date: 21 November 2013 |
|
26 .\" SectDesc: Troubleshooting Tools |
|
27 .\" Title: jmap.1 |
|
28 .\" |
|
29 .if n .pl 99999 |
|
30 .TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" |
|
31 .\" ----------------------------------------------------------------- |
|
32 .\" * Define some portability stuff |
|
33 .\" ----------------------------------------------------------------- |
|
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
35 .\" http://bugs.debian.org/507673 |
|
36 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
37 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
38 .ie \n(.g .ds Aq \(aq |
|
39 .el .ds Aq ' |
|
40 .\" ----------------------------------------------------------------- |
|
41 .\" * set default formatting |
|
42 .\" ----------------------------------------------------------------- |
|
43 .\" disable hyphenation |
|
44 .nh |
|
45 .\" disable justification (adjust text to left margin only) |
|
46 .ad l |
|
47 .\" ----------------------------------------------------------------- |
|
48 .\" * MAIN CONTENT STARTS HERE * |
|
49 .\" ----------------------------------------------------------------- |
|
50 |
|
51 .SH NAME |
|
52 jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. |
|
53 .SH SYNOPSIS |
|
54 .sp |
|
55 .nf |
|
56 |
|
57 \fBjmap\fR [ \fIoptions\fR ] \fIpid\fR |
|
58 .fi |
|
59 .nf |
|
60 |
|
61 \fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR |
|
62 .fi |
|
63 .nf |
|
64 |
|
65 \fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR |
|
66 .fi |
|
67 .sp |
|
68 .TP |
|
69 \fIoptions\fR |
|
70 The command-line options\&. See Options\&. |
|
71 .TP |
|
72 \fIpid\fR |
|
73 The process 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, use the jps(1) command\&. |
|
74 .TP |
|
75 \fIexecutable\fR |
|
76 The Java executable from which the core dump was produced\&. |
|
77 .TP |
|
78 \fIcore\fR |
|
79 The core file for which the memory map is to be printed\&. |
|
80 .TP |
|
81 \fIremote-hostname-or-IP\fR |
|
82 The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. |
|
83 .TP |
|
84 \fIserver-id\fR |
|
85 An optional unique ID to use when multiple debug servers are running on the same remote host\&. |
|
86 .SH DESCRIPTION |
|
87 The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. |
|
88 .PP |
|
89 \fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. |
|
90 .SH OPTIONS |
|
91 .TP |
|
92 <no option> |
|
93 When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. |
|
94 .TP |
|
95 -dump:[live,] format=b, file=\fIfilename\fR |
|
96 .br |
|
97 Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. |
|
98 .TP |
|
99 -finalizerinfo |
|
100 .br |
|
101 Prints information about objects that are awaiting finalization\&. |
|
102 .TP |
|
103 -heap |
|
104 .br |
|
105 Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. |
|
106 .TP |
|
107 -histo[:live] |
|
108 .br |
|
109 Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. |
|
110 .TP |
|
111 -clstats |
|
112 .br |
|
113 Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. |
|
114 .TP |
|
115 -F |
|
116 .br |
|
117 Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. |
|
118 .TP |
|
119 -h |
|
120 .br |
|
121 Prints a help message\&. |
|
122 .TP |
|
123 -help |
|
124 .br |
|
125 Prints a help message\&. |
|
126 .TP |
|
127 -J\fIflag\fR |
|
128 .br |
|
129 Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. |
|
130 .SH SEE\ ALSO |
|
131 .TP 0.2i |
|
132 \(bu |
|
133 jhat(1) |
|
134 .TP 0.2i |
|
135 \(bu |
|
136 jps(1) |
|
137 .TP 0.2i |
|
138 \(bu |
|
139 jsadebugd(1) |
|
140 .RE |
|
141 .br |
|
142 'pl 8.5i |
|
143 'bp |