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
38 .Op Fl b | c | e | f | i | j | k | l | r | s | S | t | v | x
39 .Op Fl a | Ar pid | Ar core ...
43 utility displays detailed information about the processes identified by the
47 flag is used, all processes.
48 It can also display information extracted from a process core file, if
49 the core file is specified as the argument.
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 environment variables for the process.
62 Display file descriptor information for the process.
64 Display signal pending and disposition information for the process.
66 Display signal pending and blocked information for the process's threads.
68 Display the stacks of kernel threads in the process, excluding stacks of
69 threads currently running on a CPU and threads with stacks swapped to disk.
70 If the flag is repeated, function offsets as well as function names are
73 Display resource limits for the process.
75 Display resource usage information for the process.
77 Display security credential information for the process.
79 Display the cpuset information for the thread.
81 Display thread information for the process.
83 Display virtual memory mappings for the process.
85 Display ELF auxiliary vector for the process.
88 All options generate output in the format of a table, the first field of
89 which is the process ID to which the row of information corresponds.
92 flag may be used to suppress table headers.
96 flag may be used to specify a wait interval at which to repeat the printing
97 of the requested process information.
100 flag is not specified, the output will not repeat.
104 flag requests the printing of additional capability information in the file
109 flag may be used to request per-thread statistics rather than per-process
110 statistics for some options.
111 For those options, the second field in the table will list the thread ID
112 to which the row of information corresponds.
115 flag is implied for the
119 Information for VM, file descriptor, and cpuset options is available
120 only to the owner of a process or the superuser.
121 A cpuset value displayed as -1 means that the information is either invalid
123 .Ss Binary Information
124 Display the process ID, command, and path to the process binary:
126 .Bl -tag -width indent -compact
132 osreldate for process binary
134 path to process binary (if available)
136 .Ss Command Line Arguments
137 Display the process ID, command, and command line arguments:
139 .Bl -tag -width indent -compact
145 command line arguments (if available)
147 .Ss Environment Variables
148 Display the process ID, command, and environment variables:
150 .Bl -tag -width "ENVIRONMENT" -compact
156 environment variables (if available)
159 Display detailed information about each file descriptor referenced by a
160 process, including the process ID, command, file descriptor number, and
161 per-file descriptor object information, such as object type and file system
163 By default, the following information will be printed:
165 .Bl -tag -width indent -compact
171 file descriptor number or cwd/root/jail
177 file descriptor flags
179 file descriptor reference count
181 file descriptor offset
185 file path or socket addresses (if available)
188 The following file descriptor types may be displayed:
190 .Bl -tag -width X -compact
208 pseudo-terminal master
213 The following vnode types may be displayed:
215 .Bl -tag -width X -compact
236 The following file descriptor flags may be displayed:
238 .Bl -tag -width X -compact
259 flag is specified, the vnode type, reference count, and offset fields will be
260 omitted, and a new capabilities field will be included listing capabilities,
262 .Xr cap_rights_limit 2 ,
263 present for each capability descriptor.
264 .Ss Signal Disposition Information
265 Display signal pending and disposition for a process:
267 .Bl -tag -width indent -compact
275 process signal disposition details, three symbols
276 .Bl -tag -width X -compact
278 if signal is pending in the global process queue, - otherwise
280 if signal delivery disposition is SIGIGN, - otherwise
282 if signal delivery is to catch it, - otherwise
288 switch is given, the signal numbers are shown instead of signal names.
289 .Ss Thread Signal Information
290 Display signal pending and blocked for a process's threads:
292 .Bl -tag -width indent -compact
302 thread signal delivery status, two symbols
303 .Bl -tag -width X -compact
305 if signal is pending for the thread, - otherwise
307 if signal is blocked in the thread signal mask, - if not blocked
313 switch has the same effect as for the
315 switch: the signal numbers are shown instead of signal names.
316 .Ss Kernel Thread Stacks
317 Display kernel thread stacks for a process, allowing further interpretation
318 of thread wait channels.
321 flag is repeated, function offsets, not just function names, are printed.
323 This feature requires
327 to be compiled into the kernel.
329 .Bl -tag -width indent -compact
339 kernel thread call stack
342 Display resource limits for a process:
344 .Bl -tag -width indent -compact
357 Display resource usage for a process.
361 resource usage for individual threads is displayed instead.
363 .Bl -tag -width "RESOURCE" -compact
380 .Ss Security Credentials
381 Display process credential information:
383 .Bl -tag -width indent -compact
401 file creation mode mask
408 The following credential flags may be displayed:
410 .Bl -tag -width X -compact
414 .Ss Thread Information
415 Display per-thread information, including process ID, per-thread ID, name,
416 CPU, and execution state:
418 .Bl -tag -width indent -compact
428 current or most recent CPU run on
436 .Ss Virtual Memory Mappings
437 Display process virtual memory mappings, including addresses, mapping
438 meta-data, and mapped object information:
440 .Bl -tag -width indent -compact
444 starting address of mapping
446 ending address of mapping
452 private resident pages
463 The following protection flags may be displayed:
465 .Bl -tag -width X -compact
474 The following VM object types may be displayed:
476 .Bl -tag -width XX -compact
486 device with managed pages
498 The following mapping flags may be displayed:
500 .Bl -tag -width X -compact
506 one or more superpage mappings are used
508 grows down (top-down stack)
510 grows up (bottom-up stack)
512 .Ss ELF Auxiliary Vector
513 Display ELF auxiliary vector values:
515 .Bl -tag -width indent -compact
521 auxiliary vector name
523 auxiliary vector value
532 .Xr cap_rights_limit 2 ,
536 .An Robert N M Watson
538 Some field values may include spaces, which limits the extent to which the
541 may be mechanically parsed.
543 The display of open file or memory mapping pathnames is implemented using the
545 If a file system does not use the name cache, or the path to a file is not in
546 the cache, a path will not be displayed.
549 currently supports extracting data only from a live kernel, and not from