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 | 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 LWP info for the process pertaining to it's signal driven exit.
85 Display resource usage information for the process.
87 Display security credential information for the process.
89 Display the cpuset information for the thread.
91 Display thread information for the process.
93 Display virtual memory mappings for the process.
95 Display ELF auxiliary vector for the process.
98 All options generate output in the format of a table, the first field of
99 which is the process ID to which the row of information corresponds.
102 flag may be used to suppress table headers.
106 flag may be used to specify a wait interval at which to repeat the printing
107 of the requested process information.
110 flag is not specified, the output will not repeat.
114 flag requests the printing of additional capability information in the file
119 flag may be used to request per-thread statistics rather than per-process
120 statistics for some options.
121 For those options, the second field in the table will list the thread ID
122 to which the row of information corresponds.
125 flag is implied for the
129 Information for VM, file descriptor, and cpuset options is available
130 only to the owner of a process or the superuser.
131 A cpuset value displayed as -1 means that the information is either invalid
133 .Ss Binary Information
134 Display the process ID, command, and path to the process binary:
136 .Bl -tag -width indent -compact
142 osreldate for process binary
144 path to process binary (if available)
146 .Ss Command Line Arguments
147 Display the process ID, command, and command line arguments:
149 .Bl -tag -width indent -compact
155 command line arguments (if available)
157 .Ss Environment Variables
158 Display the process ID, command, and environment variables:
160 .Bl -tag -width "ENVIRONMENT" -compact
166 environment variables (if available)
169 Display detailed information about each file descriptor referenced by a
170 process, including the process ID, command, file descriptor number, and
171 per-file descriptor object information, such as object type and file system
173 By default, the following information will be printed:
175 .Bl -tag -width indent -compact
181 file descriptor number or cwd/root/jail
187 file descriptor flags
189 file descriptor reference count
191 file descriptor offset
195 file path or socket addresses (if available)
198 The following file descriptor types may be displayed:
200 .Bl -tag -width X -compact
218 pseudo-terminal master
223 The following vnode types may be displayed:
225 .Bl -tag -width X -compact
246 The following file descriptor flags may be displayed:
248 .Bl -tag -width X -compact
269 flag is specified, the vnode type, reference count, and offset fields will be
270 omitted, and a new capabilities field will be included listing capabilities,
272 .Xr cap_rights_limit 2 ,
273 present for each capability descriptor.
274 .Ss Signal Disposition Information
275 Display signal pending and disposition for a process:
277 .Bl -tag -width indent -compact
285 process signal disposition details, three symbols
286 .Bl -tag -width X -compact
288 if signal is pending in the global process queue, - otherwise
290 if signal delivery disposition is SIGIGN, - otherwise
292 if signal delivery is to catch it, - otherwise
298 switch is given, the signal numbers are shown instead of signal names.
299 .Ss Thread Signal Information
300 Display signal pending and blocked for a process's threads:
302 .Bl -tag -width indent -compact
312 thread signal delivery status, two symbols
313 .Bl -tag -width X -compact
315 if signal is pending for the thread, - otherwise
317 if signal is blocked in the thread signal mask, - if not blocked
323 switch has the same effect as for the
325 switch: the signal numbers are shown instead of signal names.
326 .Ss Kernel Thread Stacks
327 Display kernel thread stacks for a process, allowing further interpretation
328 of thread wait channels.
331 flag is repeated, function offsets, not just function names, are printed.
333 This feature requires
337 to be compiled into the kernel.
339 .Bl -tag -width indent -compact
349 kernel thread call stack
352 Display resource limits for a process:
354 .Bl -tag -width indent -compact
367 Display resource usage for a process.
371 resource usage for individual threads is displayed instead.
373 .Bl -tag -width "RESOURCE" -compact
390 .Ss Security Credentials
391 Display process credential information:
393 .Bl -tag -width indent -compact
411 file creation mode mask
418 The following credential flags may be displayed:
420 .Bl -tag -width X -compact
424 .Ss Thread Information
425 Display per-thread information, including process ID, per-thread ID, name,
426 CPU, and execution state:
428 .Bl -tag -width indent -compact
438 current or most recent CPU run on
446 .Ss Virtual Memory Mappings
447 Display process virtual memory mappings, including addresses, mapping
448 meta-data, and mapped object information:
450 .Bl -tag -width indent -compact
454 starting address of mapping
456 ending address of mapping
462 private resident pages
473 The following protection flags may be displayed:
475 .Bl -tag -width X -compact
484 The following VM object types may be displayed:
486 .Bl -tag -width XX -compact
496 device with managed pages
508 The following mapping flags may be displayed:
510 .Bl -tag -width X -compact
516 one or more superpage mappings are used
518 grows down (top-down stack)
520 grows up (bottom-up stack)
522 .Ss ELF Auxiliary Vector
523 Display ELF auxiliary vector values:
525 .Bl -tag -width indent -compact
531 auxiliary vector name
533 auxiliary vector value
542 .Xr cap_rights_limit 2 ,
545 .Xr xo_parse_args 3 ,
549 .An Robert N M Watson Aq Mt rwatson@FreeBSD.org .
555 .Aq Mt allanjude@FreeBSD.org .
557 The display of open file or memory mapping pathnames is implemented using the
559 If a file system does not use the name cache, or the path to a file is not in
560 the cache, a path will not be displayed.
563 currently supports extracting data only from a live kernel, and not from