Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / oj-libjdwp / 2283b9d1d8f03fea8fa192c248b58726a66a6eaf / . / src / linux / doc / man / jmap.1
blob: 0d877376c77b8d77ea13c7cce6ad27a3c6ca92f4 [file] [log] [blame]
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]1." Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]2." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3."
4." This code is free software; you can redistribute it and/or modify it
5." under the terms of the GNU General Public License version 2 only, as
6." published by the Free Software Foundation.
7."
8." This code is distributed in the hope that it will be useful, but WITHOUT
9." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11." version 2 for more details (a copy is included in the LICENSE file that
12." accompanied this code).
13."
14." You should have received a copy of the GNU General Public License version
15." 2 along with this work; if not, write to the Free Software Foundation,
16." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17."
ohair2283b9d2010-05-25 15:58:33 -0700[diff] [blame^]18." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
19." or visit www.oracle.com if you need additional information or have any
20." questions.
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]21."
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]22.TH jmap 1 "04 May 2009"
23." Generated from HTML by html2man (author: Eric Armstrong)
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]24
25.LP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]26.SH "Name"
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]27jmap \- Memory Map
28.LP
29.SH "SYNOPSIS"
30.LP
31
32.LP
33.nf
34\f3
35.fl
36\fP\f3jmap\fP [ option ] pid
37.fl
38\f3jmap\fP [ option ] executable core
39.fl
40\f3jmap\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
41.fl
42.fi
43
44.LP
45.SH "PARAMETERS"
46.LP
47
48.LP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]49.RS 3
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]50.TP 3
51option
52Options are mutually exclusive. Option, if used, should follow immediately after the command name.
53.TP 3
54pid
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]55process 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.
56.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]57.TP 3
58executable
59Java executable from which the core dump was produced.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]60.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]61.TP 3
62core
63core file for which the memory map is to be printed.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]64.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]65.TP 3
66remote\-hostname\-or\-IP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]67remote debug server's (see jsadebugd(1)) hostname or IP address.
68.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]69.TP 3
70server\-id
71optional unique id, if multiple debug servers are running on the same remote host.
72.br
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]73.RE
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]74
75.LP
76.SH "DESCRIPTION"
77.LP
78
79.LP
80.LP
81\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.:
82.LP
83.RS 3
84
85.LP
86.nf
87\f3
88.fl
89jmap \-J\-d64 \-heap pid
90.fl
91\fP
92.fi
93.RE
94
95.LP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]96\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
97.LP
98\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
99.LP
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]100.br
101
102.LP
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]103.SH "OPTIONS"
104.LP
105
106.LP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]107.RS 3
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]108.TP 3
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]109<no option>
110When no option is used \f3jmap\fP 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.
111.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]112.TP 3
113\-dump:[live,]format=b,file=<filename>
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]114Dumps 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.
115.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]116.TP 3
117\-finalizerinfo
118Prints information on objects awaiting finalization.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]119.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]120.TP 3
121\-heap
122Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]123.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]124.TP 3
125\-histo[:live]
126Prints 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.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]127.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]128.TP 3
129\-permstat
130Prints 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.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]131.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]132.TP 3
133\-F
134Force. Use with jmap \-dump or jmap \-histo option if the pid does not respond. The \f2live\fP suboption is not supported in this mode.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]135.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]136.TP 3
137\-h
138Prints a help message.
139.br
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]140.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]141.TP 3
142\-help
143Prints a help message.
144.br
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]145.br
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]146.TP 3
147\-J<flag>
148Passes <flag> to the Java virtual machine on which jmap is run.
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]149.br
150.RE
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]151
152.LP
153.SH "SEE ALSO"
154.LP
155.RS 3
156.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]157o
158pmap(1)
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]159.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]160o
161jhat(1)
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]162.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]163o
164jps(1)
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]165.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]166o
167jsadebugd(1)
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]168.RE
169
170.LP
171
172.LP
173