2 .\" Copyright (c) 2007-2009 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
40 .Op Fl b | c | f | i | j | k | s | t | v
45 utility displays detailed information about the processes identified by the
49 flag is used, all processes.
51 By default, basic process statistics are printed; one of the following
52 options may be specified in order to select more detailed process information
54 .Bl -tag -width indent
56 Display binary information for the process.
58 Display command line arguments for the process.
60 Display file descriptor information for the process.
62 Display signal pending and disposition information for the process.
64 Display signal pending and blocked information for the process threads.
66 Display the stacks of kernel threads in the process, excluding stacks of
67 threads currently running on a CPU and threads with stacks swapped to disk.
68 If the flag is repeated, function offsets as well as function names are
71 Display security credential information for the process.
73 Display thread information for the process.
75 Display virtual memory mappings for the process.
78 All options generate output in the format of a table, the first field of
79 which is the process ID to which the row of information corresponds.
82 flag may be used to suppress table headers.
86 flag may be used to specify a wait interval at which to repeat the printing
87 of the requested process information.
90 flag is not specified, the output will not repeat.
94 flag requests the printing of additional capability information in the file
97 Some information, such as VM and file descriptor information, is available
98 only to the owner of a process or the superuser.
99 .Ss Binary Information
100 Display the process ID, command, and path to the process binary:
102 .Bl -tag -width indent -compact
108 path to process binary (if available)
110 .Ss Command Line Arguments
111 Display the process ID, command, and command line arguments:
113 .Bl -tag -width indent -compact
119 command line arguments (if available)
122 Display detailed information about each file descriptor referenced by a
123 process, including the process ID, command, file descriptor number, and
124 per-file descriptor object information, such as object type and file system
126 By default, the following information will be printed:
128 .Bl -tag -width indent -compact
134 file descriptor number or cwd/root/jail
140 file descriptor flags
142 file descriptor reference count
144 file descriptor offset
148 file path or socket addresses (if available)
151 The following file descriptor types may be displayed:
153 .Bl -tag -width X -compact
171 pseudo-terminal master
176 The following vnode types may be displayed:
178 .Bl -tag -width X -compact
199 The following file descriptor flags may be displayed:
201 .Bl -tag -width X -compact
219 descriptor is a capability
224 flag is specified, the vnode type, reference count, and offset fields will be
225 omitted, and a new capabilities field will be included listing capabilities,
228 present for each capability descriptor.
229 .Ss Signal Disposition Information
230 Display signal pending and disposition for a process:
232 .Bl -tag -width ident -compact
240 process signal disposition details, three symbols
241 .Bl -tag -width X -compact
243 if signal is pending in the global process queue, - otherwise
245 if signal delivery disposition is SIGIGN, - otherwise
247 if signal delivery is to catch it, - otherwise
253 switch is given, the signal numbers are shown instead of signal names.
254 .Ss Thread Signal Information
255 Display signal pending and blocked for a process threads:
257 .Bl -tag -width ident -compact
267 thread signal delivery status, two symbols
268 .Bl -tag -width X -compact
270 if signal is pending for the thread, - otherwise
272 if signal is blocked in the thread signal mask, - if not blocked
278 switch has the same effect as for the
280 switch, the signals numbers are shown instead of signal names.
281 .Ss Kernel Thread Stacks
282 Display kernel thread stacks for a process, allowing further interpretation
283 of thread wait channels.
286 flag is repeated, function offsets, not just function names, are printed.
288 This feature requires
292 to be compiled into the kernel.
294 .Bl -tag -width indent -compact
304 kernel thread call stack
306 .Ss Security Credentials
307 Display process credential information:
309 .Bl -tag -width indent -compact
332 The following credential flags may be displayed:
334 .Bl -tag -width X -compact
338 .Ss Thread Information
339 Display per-thread information, including process ID, per-thread ID, name,
340 CPU, and execution state:
342 .Bl -tag -width indent -compact
352 current or most recent CPU run on
360 .Ss Virtual Memory Mappings
361 Display process virtual memory mappings, including addresses, mapping
362 meta-data, and mapped object information:
364 .Bl -tag -width indent -compact
368 starting address of mapping
370 ending address of mapping
376 private resident pages
387 The following protection flags may be displayed:
389 .Bl -tag -width X -compact
398 The following VM object types may be displayed:
400 .Bl -tag -width XX -compact
417 The following mapping flags may be displayed:
419 .Bl -tag -width X -compact
436 .An Robert N M Watson
438 Some field values may include spaces, which limits the extent to which the
441 may be mechanically parsed.
443 The display of open file or memory mapping pathnames is implemented using the
445 If a file system does not use the name cache, or the path to a file is not in
446 the cache, a path will not be displayed.
449 currently supports extracting data only from a live kernel, and not from