From 1646160d80aff38869d003100ab987fc9d8fea59 Mon Sep 17 00:00:00 2001 From: rwatson Date: Sat, 19 Apr 2008 13:40:42 +0000 Subject: Provide more detailed information about each procstat(1) display mode, including a key to fields in each mode and flag abbreviations. MFC after: 3 days X-MFC-note: POSIX shared memory memory objects aren't in 7-STABLE yet --- usr.bin/procstat/procstat.1 | 255 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 248 insertions(+), 7 deletions(-) (limited to 'usr.bin/procstat') diff --git a/usr.bin/procstat/procstat.1 b/usr.bin/procstat/procstat.1 index d6d30d5..32fc81a 100644 --- a/usr.bin/procstat/procstat.1 +++ b/usr.bin/procstat/procstat.1 @@ -1,5 +1,5 @@ .\"- -.\" Copyright (c) 2007 Robert N. M. Watson +.\" Copyright (c) 2007-2008 Robert N. M. Watson .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 30, 2007 +.Dd April 19, 2008 .Dt PROCSTAT 1 .Os .Sh NAME @@ -61,11 +61,6 @@ Display the stacks of kernel threads in the process, excluding stacks of threads currently running on a CPU and threads with stacks swapped to disk. If the flag is repeated, function offsets as well as function names are printed. -This feature requires -.Cd "options STACK" -or -.Cd "options DDB" -to be compiled into the kernel. .It Fl s Display security credential information for the process. .It Fl t @@ -90,6 +85,252 @@ flag is not specified, the output will not repeat. .Pp Some information, such as VM and file descriptor information, is available only to the owner of a process or the superuser. +.Ss Binary Information +Display the process ID, command, and path to the process binary: +.Pp +.Bl -tag -width indent -compact +.It PID +process ID +.It COMM +command +.It PATH +path to process binary (if available) +.El +.Ss Command Line Arguments +Display the process ID, command, and command line arguments: +.Pp +.Bl -tag -width indent -compact +.It PID +process ID +.It COMM +command +.It ARGS +command line arguments (if available) +.El +.Ss File Descriptors +Display detailed information about each file descriptor referenced by a +process, including the process ID, command, file descriptor number, and +per-file descriptor object information, such as object type and file system +path: +.Pp +.Bl -tag -width indent -compact +.It PID +process ID +.It COMM +command +.It FD +file descriptor number or cwd/root/jail +.It T +file descriptor type +.It V +vnode type +.It FLAGS +file descriptor flags +.It REF +file descriptor reference count +.It OFFSET +file descriptor offset +.It PRO +network protocol +.It NAME +file path or socket addresses (if available) +.El +.Pp +The following file descriptor types may be displayed: +.Pp +.Bl -tag -width X -compact +.It c +crypto +.It f +fifo +.It h +shared memory +.It k +kqueue +.It m +messsage queue +.It p +pipe +.It s +socket +.It v +vnode +.El +.Pp +The following vnode types may be displayed: +.Pp +.Bl -tag -width X -compact +.It - +not a vnode +.It b +block device +.It c +character device +.It f +fifo +.It l +symbolic link +.It s +socket +.It x +revoked device +.El +.Pp +The following file descriptor flags may be displayed: +.Pp +.Bl -tag -width X -compact +.It r +read +.It w +write +.It a +append +.It s +async +.It f +fsync +.It n +non-blocking +.It d +direct I/O +.It l +lock held +.El +.Ss Kernel Thread Stacks +Display kernel thread stacks for a process, allowing further interpretation +of thread wait channels. +If the +.Fl k +flag is reeated, function offsets, not just function names, are printed. +.Pp +This feature requires +.Cd "options STACK" +or +.Cd "options DDB" +to be compiled into the kernel. +.Pp +.Bl -tag -width indent -compact +.It PID +process ID +.It TID +thread ID +.It COMM +command +.It TDNAME +thread name +.It KSTACK +kernel thread call stack +.El +.Ss Security Credentials +Display process credential information: +.Pp +.Bl -tag -width indent -compact +.It PID +process ID +.It COMM +command +.It EUID +effective user ID +.It RUID +real user ID +.It SVUID +saved user ID +.It EGID +effective group ID +.It RGID +real group ID +.It SVGID +saved group ID +.It GROUPS +group set +.El +.Ss Thread Information +Display per-thread information, including process ID, per-thread ID, name, +CPU, and execution state: +.Pp +.Bl -tag -width indent -compact +.It PID +process ID +.It TID +thread ID +.It COMM +command +.It TDNAME +thread name +.It CPU +current or most recent CPU run on +.It PRI +thread priority +.It STATE +thread state +.It WCHAN +thread wait channel +.El +.Ss Virtual Memory Mappings +Display process virtual memory mappings, including addresses, mapping +meta-data, and mapped object information: +.Pp +.Bl -tag -width indent -compact +.It PID +process ID +.It START +starting address of mapping +.It END +ending address of mapping +.It PRT +protection flags +.It RES +resident pages +.It PRES +private resident pages +.It REF +reference count +.It SHD +shadow page count +.It FL +mapping flags +.It TP +VM object type +.El +.Pp +The following protection flags may be displayed: +.Pp +.Bl -tag -width X -compact +.It r +read +.It w +write +.It x +execute +.El +.Pp +The following VM object types may be displayed: +.Pp +.Bl -tag -width XX -compact +.It -- +none +.It dd +dead +.It df +default +.It dv +device +.It ph +physical +.It sw +swap +.It vn +vnode +.El +.Pp +The following mapping flags may be displayed: +.Pp +.Bl -tag -width X -compact +.It C +copy-on-write +.It N +needs copy +.El .Sh EXIT STATUS .Ex -std .Sh SEE ALSO -- cgit v1.1