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 | 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 thread information for the process.
81 Display virtual memory mappings for the process.
83 Display ELF auxiliary vector for the process.
86 All options generate output in the format of a table, the first field of
87 which is the process ID to which the row of information corresponds.
90 flag may be used to suppress table headers.
94 flag may be used to specify a wait interval at which to repeat the printing
95 of the requested process information.
98 flag is not specified, the output will not repeat.
102 flag requests the printing of additional capability information in the file
107 flag may be used to request per-thread statistics rather than per-process
108 statistics for some options.
109 For those options, the second field in the table will list the thread ID
110 to which the row of information corresponds.
112 Some information, such as VM and file descriptor information, is available
113 only to the owner of a process or the superuser.
114 .Ss Binary Information
115 Display the process ID, command, and path to the process binary:
117 .Bl -tag -width indent -compact
123 osreldate for process binary
125 path to process binary (if available)
127 .Ss Command Line Arguments
128 Display the process ID, command, and command line arguments:
130 .Bl -tag -width indent -compact
136 command line arguments (if available)
138 .Ss Environment Variables
139 Display the process ID, command, and environment variables:
141 .Bl -tag -width "ENVIRONMENT" -compact
147 environment variables (if available)
150 Display detailed information about each file descriptor referenced by a
151 process, including the process ID, command, file descriptor number, and
152 per-file descriptor object information, such as object type and file system
154 By default, the following information will be printed:
156 .Bl -tag -width indent -compact
162 file descriptor number or cwd/root/jail
168 file descriptor flags
170 file descriptor reference count
172 file descriptor offset
176 file path or socket addresses (if available)
179 The following file descriptor types may be displayed:
181 .Bl -tag -width X -compact
199 pseudo-terminal master
204 The following vnode types may be displayed:
206 .Bl -tag -width X -compact
227 The following file descriptor flags may be displayed:
229 .Bl -tag -width X -compact
247 descriptor is a capability
252 flag is specified, the vnode type, reference count, and offset fields will be
253 omitted, and a new capabilities field will be included listing capabilities,
256 present for each capability descriptor.
257 .Ss Signal Disposition Information
258 Display signal pending and disposition for a process:
260 .Bl -tag -width indent -compact
268 process signal disposition details, three symbols
269 .Bl -tag -width X -compact
271 if signal is pending in the global process queue, - otherwise
273 if signal delivery disposition is SIGIGN, - otherwise
275 if signal delivery is to catch it, - otherwise
281 switch is given, the signal numbers are shown instead of signal names.
282 .Ss Thread Signal Information
283 Display signal pending and blocked for a process's threads:
285 .Bl -tag -width indent -compact
295 thread signal delivery status, two symbols
296 .Bl -tag -width X -compact
298 if signal is pending for the thread, - otherwise
300 if signal is blocked in the thread signal mask, - if not blocked
306 switch has the same effect as for the
308 switch: the signal numbers are shown instead of signal names.
309 .Ss Kernel Thread Stacks
310 Display kernel thread stacks for a process, allowing further interpretation
311 of thread wait channels.
314 flag is repeated, function offsets, not just function names, are printed.
316 This feature requires
320 to be compiled into the kernel.
322 .Bl -tag -width indent -compact
332 kernel thread call stack
335 Display resource limits for a process:
337 .Bl -tag -width indent -compact
350 Display resource usage for a process.
354 resource usage for individual threads is displayed instead.
356 .Bl -tag -width "RESOURCE" -compact
373 .Ss Security Credentials
374 Display process credential information:
376 .Bl -tag -width indent -compact
394 file creation mode mask
401 The following credential flags may be displayed:
403 .Bl -tag -width X -compact
407 .Ss Thread Information
408 Display per-thread information, including process ID, per-thread ID, name,
409 CPU, and execution state:
411 .Bl -tag -width indent -compact
421 current or most recent CPU run on
429 .Ss Virtual Memory Mappings
430 Display process virtual memory mappings, including addresses, mapping
431 meta-data, and mapped object information:
433 .Bl -tag -width indent -compact
437 starting address of mapping
439 ending address of mapping
445 private resident pages
456 The following protection flags may be displayed:
458 .Bl -tag -width X -compact
467 The following VM object types may be displayed:
469 .Bl -tag -width XX -compact
479 device with managed pages
491 The following mapping flags may be displayed:
493 .Bl -tag -width X -compact
499 one or more superpage mappings are used
501 grows down (top-down stack)
503 grows up (bottom-up stack)
505 .Ss ELF Auxiliary Vector
506 Display ELF auxiliary vector values:
508 .Bl -tag -width indent -compact
514 auxiliary vector name
516 auxiliary vector value
529 .An Robert N M Watson
531 Some field values may include spaces, which limits the extent to which the
534 may be mechanically parsed.
536 The display of open file or memory mapping pathnames is implemented using the
538 If a file system does not use the name cache, or the path to a file is not in
539 the cache, a path will not be displayed.
542 currently supports extracting data only from a live kernel, and not from