jdk/src/linux/doc/man/jstack.1
author bpatel
Wed, 14 Jul 2010 15:42:06 -0700
changeset 5865 47da38a8c0f0
parent 5506 202f599c92aa
child 9573 c02ff5a7c67b
permissions -rw-r--r--
6955341: Oracle rebranding changes for man pages Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5865
47da38a8c0f0 6955341: Oracle rebranding changes for man pages
bpatel
parents: 5506
diff changeset
     1
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
." This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
." under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
." published by the Free Software Foundation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
." This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
." version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
." accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
." You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
." 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
."
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    18
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    19
." or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    20
." questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
."
5865
47da38a8c0f0 6955341: Oracle rebranding changes for man pages
bpatel
parents: 5506
diff changeset
    22
.TH jstack 1 "02 Jun 2010"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    25
.SH "Name"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
jstack \- Stack Trace
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
.SH "SYNOPSIS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
\fP\f3jstack\fP [ option ] pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
\f3jstack\fP [ option ] executable core
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
\f3jstack\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
.SH "PARAMETERS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
pid 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    56
process id for which the stack trace 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. 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
executable 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
Java executable from which the core dump was produced. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
core 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
core file for which the stack trace is to be printed. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
remote\-hostname\-or\-IP 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    71
remote debug server's (see jsadebugd(1)) hostname or IP address. 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
server\-id 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
optional unique id, if multiple debug servers are running on the same remote host. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
.SH "DESCRIPTION"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
\f3jstack\fP prints Java stack traces of Java threads for a given Java process or core file or a remote debug server. For each Java frame, the full class name, method name, 'bci' (byte code index) and line number, if available, are printed. With the \-m option, jstack prints both Java and native frames of all threads along with the 'pc' (program counter). For each native frame, the closest native symbol to 'pc', if available, is printed. C++ mangled names are not demangled. To demangle C++ names, the output of this command may be piped to \f3c++filt\fP. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
jstack \-J\-d64 \-m pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   102
\f3NOTE\fP \- 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, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   104
.LP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   105
For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
.SH "OPTIONS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
\-F 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   114
Force a stack dump when 'jstack [\-l] pid' does not respond. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   115
.TP 3
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   116
\-l 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   117
Long listing. Prints additional information about locks such as list of owned java.util.concurrent 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   118
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   119
\f2ownable synchronizers\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   120
.fi
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   121
http://java.sun.com/javase/6/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html. 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
\-m 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
prints mixed mode (both Java and native C/C++ frames) stack trace. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
\-h 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
prints a help message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
\-help 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
prints a help message
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
.SH "SEE ALSO"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
o
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
pstack(1) 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
o
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
c++filt(1) 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
o
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   148
jps(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
o
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   151
jsadebugd(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
.SH "KNOWN BUGS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
Mixed mode stack trace, the \-m option, does not work with the remote debug server.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162