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
39 .Op Fl b | c | e | f | i | j | k | l | r | s | S | t | v | x
40 .Op Fl a | Ar pid | Ar core ...
44 utility displays detailed information about the processes identified by the
48 flag is used, all processes.
49 It can also display information extracted from a process core file, if
50 the core file is specified as the argument.
52 By default, basic process statistics are printed; one of the following
53 options may be specified in order to select more detailed process information
55 .Bl -tag -width indent
59 in a selection of different human and machine readable formats.
62 for details on command line arguments.
64 Display binary information for the process.
66 Display command line arguments for the process.
68 Display environment variables for the process.
70 Display file descriptor information for the process.
72 Display signal pending and disposition information for the process.
74 Display signal pending and blocked information for the process's threads.
76 Display the stacks of kernel threads in the process, excluding stacks of
77 threads currently running on a CPU and threads with stacks swapped to disk.
78 If the flag is repeated, function offsets as well as function names are
81 Display resource limits for the process.
83 Display resource usage information for the process.
85 Display security credential information for the process.
87 Display the cpuset information for the thread.
89 Display thread information for the process.
91 Display virtual memory mappings for the process.
93 Display ELF auxiliary vector for the process.
96 All options generate output in the format of a table, the first field of
97 which is the process ID to which the row of information corresponds.
100 flag may be used to suppress table headers.
104 flag may be used to specify a wait interval at which to repeat the printing
105 of the requested process information.
108 flag is not specified, the output will not repeat.
112 flag requests the printing of additional capability information in the file
117 flag may be used to request per-thread statistics rather than per-process
118 statistics for some options.
119 For those options, the second field in the table will list the thread ID
120 to which the row of information corresponds.
123 flag is implied for the
127 Information for VM, file descriptor, and cpuset options is available
128 only to the owner of a process or the superuser.
129 A cpuset value displayed as -1 means that the information is either invalid
131 .Ss Binary Information
132 Display the process ID, command, and path to the process binary:
134 .Bl -tag -width indent -compact
140 osreldate for process binary
142 path to process binary (if available)
144 .Ss Command Line Arguments
145 Display the process ID, command, and command line arguments:
147 .Bl -tag -width indent -compact
153 command line arguments (if available)
155 .Ss Environment Variables
156 Display the process ID, command, and environment variables:
158 .Bl -tag -width "ENVIRONMENT" -compact
164 environment variables (if available)
167 Display detailed information about each file descriptor referenced by a
168 process, including the process ID, command, file descriptor number, and
169 per-file descriptor object information, such as object type and file system
171 By default, the following information will be printed:
173 .Bl -tag -width indent -compact
179 file descriptor number or cwd/root/jail
185 file descriptor flags
187 file descriptor reference count
189 file descriptor offset
193 file path or socket addresses (if available)
196 The following file descriptor types may be displayed:
198 .Bl -tag -width X -compact
216 pseudo-terminal master
221 The following vnode types may be displayed:
223 .Bl -tag -width X -compact
244 The following file descriptor flags may be displayed:
246 .Bl -tag -width X -compact
267 flag is specified, the vnode type, reference count, and offset fields will be
268 omitted, and a new capabilities field will be included listing capabilities,
270 .Xr cap_rights_limit 2 ,
271 present for each capability descriptor.
272 .Ss Signal Disposition Information
273 Display signal pending and disposition for a process:
275 .Bl -tag -width indent -compact
283 process signal disposition details, three symbols
284 .Bl -tag -width X -compact
286 if signal is pending in the global process queue, - otherwise
288 if signal delivery disposition is SIGIGN, - otherwise
290 if signal delivery is to catch it, - otherwise
296 switch is given, the signal numbers are shown instead of signal names.
297 .Ss Thread Signal Information
298 Display signal pending and blocked for a process's threads:
300 .Bl -tag -width indent -compact
310 thread signal delivery status, two symbols
311 .Bl -tag -width X -compact
313 if signal is pending for the thread, - otherwise
315 if signal is blocked in the thread signal mask, - if not blocked
321 switch has the same effect as for the
323 switch: the signal numbers are shown instead of signal names.
324 .Ss Kernel Thread Stacks
325 Display kernel thread stacks for a process, allowing further interpretation
326 of thread wait channels.
329 flag is repeated, function offsets, not just function names, are printed.
331 This feature requires
335 to be compiled into the kernel.
337 .Bl -tag -width indent -compact
347 kernel thread call stack
350 Display resource limits for a process:
352 .Bl -tag -width indent -compact
365 Display resource usage for a process.
369 resource usage for individual threads is displayed instead.
371 .Bl -tag -width "RESOURCE" -compact
388 .Ss Security Credentials
389 Display process credential information:
391 .Bl -tag -width indent -compact
409 file creation mode mask
416 The following credential flags may be displayed:
418 .Bl -tag -width X -compact
422 .Ss Thread Information
423 Display per-thread information, including process ID, per-thread ID, name,
424 CPU, and execution state:
426 .Bl -tag -width indent -compact
436 current or most recent CPU run on
444 .Ss Virtual Memory Mappings
445 Display process virtual memory mappings, including addresses, mapping
446 meta-data, and mapped object information:
448 .Bl -tag -width indent -compact
452 starting address of mapping
454 ending address of mapping
460 private resident pages
471 The following protection flags may be displayed:
473 .Bl -tag -width X -compact
482 The following VM object types may be displayed:
484 .Bl -tag -width XX -compact
494 device with managed pages
506 The following mapping flags may be displayed:
508 .Bl -tag -width X -compact
514 one or more superpage mappings are used
516 grows down (top-down stack)
518 grows up (bottom-up stack)
520 .Ss ELF Auxiliary Vector
521 Display ELF auxiliary vector values:
523 .Bl -tag -width indent -compact
529 auxiliary vector name
531 auxiliary vector value
540 .Xr cap_rights_limit 2 ,
543 .Xr xo_parse_args 3 ,
547 .An Robert N M Watson Aq Mt rwatson@FreeBSD.org .
553 .Aq Mt allanjude@FreeBSD.org .
555 The display of open file or memory mapping pathnames is implemented using the
557 If a file system does not use the name cache, or the path to a file is not in
558 the cache, a path will not be displayed.
561 currently supports extracting data only from a live kernel, and not from