2 .\" Copyright (c) 2007-2008 Robert N. M. Watson
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd get detailed process information
39 .Op Fl b | c | f | i | j | k | s | t | v
44 utility displays detailed information about the processes identified by the
48 flag is used, all processes.
50 By default, basic process statistics are printed; one of the following
51 options may be specified in order to select more detailed process information
53 .Bl -tag -width indent
55 Display binary information for the process.
57 Display command line arguments for the process.
59 Display file descriptor information for the process.
61 Display signal pending and disposition information for the process.
63 Display signal pending and blocked information for the process threads.
65 Display the stacks of kernel threads in the process, excluding stacks of
66 threads currently running on a CPU and threads with stacks swapped to disk.
67 If the flag is repeated, function offsets as well as function names are
70 Display security credential information for the process.
72 Display thread information for the process.
74 Display virtual memory mappings for the process.
77 All options generate output in the format of a table, the first field of
78 which is the process ID to which the row of information corresponds.
81 flag may be used to suppress table headers.
85 flag may be used to specify a wait interval at which to repeat the printing
86 of the requested process information.
89 flag is not specified, the output will not repeat.
91 Some information, such as VM and file descriptor information, is available
92 only to the owner of a process or the superuser.
93 .Ss Binary Information
94 Display the process ID, command, and path to the process binary:
96 .Bl -tag -width indent -compact
102 path to process binary (if available)
104 .Ss Command Line Arguments
105 Display the process ID, command, and command line arguments:
107 .Bl -tag -width indent -compact
113 command line arguments (if available)
116 Display detailed information about each file descriptor referenced by a
117 process, including the process ID, command, file descriptor number, and
118 per-file descriptor object information, such as object type and file system
121 .Bl -tag -width indent -compact
127 file descriptor number or cwd/root/jail
133 file descriptor flags
135 file descriptor reference count
137 file descriptor offset
141 file path or socket addresses (if available)
144 The following file descriptor types may be displayed:
146 .Bl -tag -width X -compact
162 pseudo-terminal master
167 The following vnode types may be displayed:
169 .Bl -tag -width X -compact
186 The following file descriptor flags may be displayed:
188 .Bl -tag -width X -compact
206 .Ss Signal Disposition Information
207 Display signal pending and disposition for a process:
209 .Bl -tag -width ident -compact
217 process signal disposition details, three symbols
218 .Bl -tag -width X -compact
220 if signal is pending in the global process queue, - otherwise
222 if signal delivery disposition is SIGIGN, - otherwise
224 if signal delivery is to catch it, - otherwise
230 switch is given, the signal numbers are shown instead of signal names.
231 .Ss Thread Signal Information
232 Display signal pending and blocked for a process threads:
234 .Bl -tag -width ident -compact
244 thread signal delivery status, two symbols
245 .Bl -tag -width X -compact
247 if signal is pending for the thread, - otherwise
249 if signal is blocked in the thread signal mask, - if not blocked
255 switch has the same effect as for the
257 switch, the signals numbers are shown instead of signal names.
258 .Ss Kernel Thread Stacks
259 Display kernel thread stacks for a process, allowing further interpretation
260 of thread wait channels.
263 flag is repeated, function offsets, not just function names, are printed.
265 This feature requires
269 to be compiled into the kernel.
271 .Bl -tag -width indent -compact
281 kernel thread call stack
283 .Ss Security Credentials
284 Display process credential information:
286 .Bl -tag -width indent -compact
306 .Ss Thread Information
307 Display per-thread information, including process ID, per-thread ID, name,
308 CPU, and execution state:
310 .Bl -tag -width indent -compact
320 current or most recent CPU run on
328 .Ss Virtual Memory Mappings
329 Display process virtual memory mappings, including addresses, mapping
330 meta-data, and mapped object information:
332 .Bl -tag -width indent -compact
336 starting address of mapping
338 ending address of mapping
344 private resident pages
355 The following protection flags may be displayed:
357 .Bl -tag -width X -compact
366 The following VM object types may be displayed:
368 .Bl -tag -width XX -compact
385 The following mapping flags may be displayed:
387 .Bl -tag -width X -compact
402 .An Robert N M Watson
404 Some field values may include spaces, which limits the extent to which the
407 may be mechanically parsed.
409 The display of open file or memory mapping pathnames is implemented using the
411 If a file system does not use the name cache, or the path to a file is not in
412 the cache, a path will not be displayed.
415 currently supports extracting data only from a live kernel, and not from