Index: head/lib/libprocstat/Makefile =================================================================== --- head/lib/libprocstat/Makefile (revision 283166) +++ head/lib/libprocstat/Makefile (revision 283167) @@ -1,41 +1,71 @@ # $FreeBSD$ .include LIB= procstat SRCS= cd9660.c \ common_kvm.c \ core.c \ libprocstat.c \ msdosfs.c \ smbfs.c \ udf.c VERSION_DEF= ${.CURDIR}/Versions.def SYMBOL_MAPS= ${.CURDIR}/Symbol.map INCS= libprocstat.h CFLAGS+= -I. -I${.CURDIR} -D_KVM_VNODE SHLIB_MAJOR= 1 LIBADD= elf kvm util MAN= libprocstat.3 +MLINKS+=libprocstat.3 procstat_close.3 \ + libprocstat.3 procstat_freeargv.3 \ + libprocstat.3 procstat_freeauxv.3 \ + libprocstat.3 procstat_freeenvv.3 \ + libprocstat.3 procstat_freefiles.3 \ + libprocstat.3 procstat_freegroups.3 \ + libprocstat.3 procstat_freekstack.3 \ + libprocstat.3 procstat_freeprocs.3 \ + libprocstat.3 procstat_freevmmap.3 \ + libprocstat.3 procstat_get_pipe_info.3 \ + libprocstat.3 procstat_get_pts_info.3 \ + libprocstat.3 procstat_get_sem_info.3 \ + libprocstat.3 procstat_get_shm_info.3 \ + libprocstat.3 procstat_get_socket_info.3 \ + libprocstat.3 procstat_get_vnode_info.3 \ + libprocstat.3 procstat_getargv.3 \ + libprocstat.3 procstat_getauxv.3 \ + libprocstat.3 procstat_getenvv.3 \ + libprocstat.3 procstat_getfiles.3 \ + libprocstat.3 procstat_getgroups.3 \ + libprocstat.3 procstat_getkstack.3 \ + libprocstat.3 procstat_getosrel.3 \ + libprocstat.3 procstat_getpathname.3 \ + libprocstat.3 procstat_getprocs.3 \ + libprocstat.3 procstat_getrlimit.3 \ + libprocstat.3 procstat_getumask.3 \ + libprocstat.3 procstat_getvmmap.3 \ + libprocstat.3 procstat_open_core.3 \ + libprocstat.3 procstat_open_kvm.3 \ + libprocstat.3 procstat_open_sysctl.3 # XXX This is a hack. .if ${MK_CDDL} != "no" CFLAGS+= -DLIBPROCSTAT_ZFS OBJS+= zfs/zfs.o SOBJS+= zfs/zfs.So POBJS+= zfs/zfs.po SUBDIR= zfs zfs/zfs.o: .PHONY @cd ${.CURDIR}/zfs && ${MAKE} zfs.o zfs/zfs.So: .PHONY @cd ${.CURDIR}/zfs && ${MAKE} zfs.So zfs/zfs.po: .PHONY @cd ${.CURDIR}/zfs && ${MAKE} zfs.po .endif .include Index: head/lib/libprocstat/libprocstat.3 =================================================================== --- head/lib/libprocstat/libprocstat.3 (revision 283166) +++ head/lib/libprocstat/libprocstat.3 (revision 283167) @@ -1,549 +1,550 @@ .\" Copyright (c) 2011 Sergey Kandaurov .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" -.Dd May 3, 2013 +.Dd May 18, 2015 .Dt LIBPROCSTAT 3 .Os .Sh NAME -.Nm procstat_open_core , -.Nm procstat_open_kvm , -.Nm procstat_open_sysctl , .Nm procstat_close , -.Nm procstat_getargv , -.Nm procstat_getauxv , -.Nm procstat_getenvv , -.Nm procstat_getfiles , -.Nm procstat_getgroups , -.Nm procstat_getkstack , -.Nm procstat_getosrel , -.Nm procstat_getpathname , -.Nm procstat_getprocs , -.Nm procstat_getumask , -.Nm procstat_getvmmap , .Nm procstat_freeargv , .Nm procstat_freeauxv , .Nm procstat_freeenvv , .Nm procstat_freefiles , .Nm procstat_freegroups , .Nm procstat_freekstack , .Nm procstat_freeprocs , .Nm procstat_freevmmap , .Nm procstat_get_pipe_info , .Nm procstat_get_pts_info , .Nm procstat_get_sem_info , .Nm procstat_get_shm_info , .Nm procstat_get_socket_info , -.Nm procstat_get_vnode_info +.Nm procstat_get_vnode_info , +.Nm procstat_getargv , +.Nm procstat_getauxv , +.Nm procstat_getenvv , +.Nm procstat_getfiles , +.Nm procstat_getgroups , +.Nm procstat_getkstack , +.Nm procstat_getosrel , +.Nm procstat_getpathname , +.Nm procstat_getprocs , +.Nm procstat_getrlimit , +.Nm procstat_getumask , +.Nm procstat_getvmmap , +.Nm procstat_open_core , +.Nm procstat_open_kvm , +.Nm procstat_open_sysctl .Nd library interface for file and process information retrieval .Sh LIBRARY .Lb libprocstat .Sh SYNOPSIS .In sys/param.h .In sys/queue.h .In libprocstat.h .Ft void .Fn procstat_close "struct procstat *procstat" .Ft void .Fo procstat_freeargv .Fa "struct procstat *procstat" .Fc .Ft void .Fo procstat_freeauxv .Fa "struct procstat *procstat" .Fa "Elf_Auxinfo *auxv" .Fc .Ft void .Fo procstat_freeenvv .Fa "struct procstat *procstat" .Fc .Ft void .Fo procstat_freefiles .Fa "struct procstat *procstat" .Fa "struct filestat_list *head" .Fc .Ft void .Fo procstat_freegroups .Fa "struct procstat *procstat" .Fa "gid_t *groups" .Fc .Ft void .Fo procstat_freekstack .Fa "struct procstat *procstat" .Fa "struct kinfo_kstack *kkstp" .Fc .Ft void .Fn procstat_freeprocs "struct procstat *procstat" "struct kinfo_proc *p" .Ft void .Fo procstat_freevmmap .Fa "struct procstat *procstat" .Fa "struct kinfo_vmentry *vmmap" .Fc .Ft int .Fo procstat_get_pipe_info .Fa "struct procstat *procstat" .Fa "struct filestat *fst" .Fa "struct pipestat *pipe" .Fa "char *errbuf" .Fc .Ft int .Fo procstat_get_pts_info .Fa "struct procstat *procstat" .Fa "struct filestat *fst" .Fa "struct ptsstat *pts" .Fa "char *errbuf" .Fc .Ft int .Fo procstat_get_sem_info .Fa "struct procstat *procstat" .Fa "struct filestat *fst" .Fa "struct semstat *sem" .Fa "char *errbuf" .Fc .Ft int .Fo procstat_get_shm_info .Fa "struct procstat *procstat" .Fa "struct filestat *fst" .Fa "struct shmstat *shm" .Fa "char *errbuf" .Fc .Ft int .Fo procstat_get_socket_info .Fa "struct procstat *procstat" .Fa "struct filestat *fst" .Fa "struct sockstat *sock" .Fa "char *errbuf" .Fc .Ft int .Fo procstat_get_vnode_info .Fa "struct procstat *procstat" .Fa "struct filestat *fst" .Fa "struct vnstat *vn" .Fa "char *errbuf" .Fc .Ft "char **" .Fo procstat_getargv .Fa "struct procstat *procstat" .Fa "const struct kinfo_proc *kp" .Fa "size_t nchr" .Fa "char *errbuf" .Fc .Ft "Elf_Auxinfo *" .Fo procstat_getauxv .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "unsigned int *count" .Fc .Ft "char **" .Fo procstat_getenvv .Fa "struct procstat *procstat" .Fa "const struct kinfo_proc *kp" .Fa "size_t nchr" .Fa "char *errbuf" .Fc .Ft "struct filestat_list *" .Fo procstat_getfiles .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "int mmapped" .Fc .Ft "gid_t *" .Fo procstat_getgroups .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "unsigned int *count" .Fc +.Ft "struct kinfo_kstack *" +.Fo procstat_getkstack +.Fa "struct procstat *procstat" +.Fa "struct kinfo_proc *kp" +.Fa "unsigned int *count" +.Fc .Ft int .Fo procstat_getosrel .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "int *osrelp" .Fc -.Ft "struct kinfo_kstack *" -.Fo procstat_getkstack +.Ft "int" +.Fo procstat_getpathname .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" -.Fa "unsigned int *count" +.Fa "char *pathname" +.Fa "size_t maxlen" .Fc .Ft "struct kinfo_proc *" .Fo procstat_getprocs .Fa "struct procstat *procstat" .Fa "int what" .Fa "int arg" .Fa "unsigned int *count" -.Fc -.Ft "int" -.Fo procstat_getpathname -.Fa "struct procstat *procstat" -.Fa "struct kinfo_proc *kp" -.Fa "char *pathname" -.Fa "size_t maxlen" .Fc .Ft "int" .Fo procstat_getrlimit .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "int which" .Fa "struct rlimit* rlimit" .Fc .Ft "int" .Fo procstat_getumask .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "unsigned short *maskp" .Fc .Ft "struct kinfo_vmentry *" .Fo procstat_getvmmap .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "unsigned int *count" .Fc .Ft "struct procstat *" .Fn procstat_open_core "const char *filename" .Ft "struct procstat *" .Fn procstat_open_kvm "const char *nlistf" "const char *memf" .Ft "struct procstat *" .Fn procstat_open_sysctl void .Sh DESCRIPTION The .Nm libprocstat library contains the API for runtime file and process information retrieval from the running kernel via the .Xr sysctl 3 library backend, and for post-mortem analysis via the .Xr kvm 3 library backend, or from the process .Xr core 5 file, searching for statistics in special .Xr elf 3 note sections. .Pp The .Fn procstat_open_kvm and .Fn procstat_open_sysctl functions use the .Xr kvm 3 or .Xr sysctl 3 library routines, respectively, to access kernel state information used to retrieve processes and files states. The .Fn procstat_open_core uses .Xr elf 3 routines to access statistics stored as a set of notes in a process .Xr core 5 file, written by the kernel at the moment of the process abnormal termination. The .Fa filename argument is the process core file name. The .Fa nlistf argument is the executable image of the kernel being examined. If this argument is .Dv NULL , the currently running kernel is assumed. The .Fa memf argument is the kernel memory device file. If this argument is .Dv NULL , then .Pa /dev/mem is assumed. See .Xr kvm_open 3 for more details. The functions dynamically allocate and return a .Vt procstat structure pointer used in the rest of the .Nm libprocstat library routines until the corresponding .Fn procstat_close call that cleans up the resources allocated by the .Fn procstat_open_* functions. .Pp The .Fn procstat_getprocs function gets a pointer to the .Vt procstat structure from one of the .Fn procstat_open_* functions and returns a dynamically allocated (sub-)set of active processes in the kernel filled in to array of .Vt kinfo_proc structures. The .Fa what and .Fa arg arguments constitute a filtering predicate as described in the .Xr kvm_getprocs 3 function. The number of processes found is returned in the reference parameter .Fa cnt . The caller is responsible to free the allocated memory with a subsequent .Fn procstat_freeprocs function call. .Pp The .Fn procstat_getargv function gets a pointer to the .Vt procstat structure from one of the .Fn procstat_open_* functions, a pointer to .Vt kinfo_proc structure from the array obtained from the .Fn kvm_getprocs function, and returns a null-terminated argument vector that corresponds to the command line arguments passed to the process. The .Fa nchr argument indicates the maximum number of characters, including null bytes, to use in building the strings. If this amount is exceeded, the string causing the overflow is truncated and the partial result is returned. This is handy for programs that print only a one line summary of a command and should not copy out large amounts of text only to ignore it. If .Fa nchr is zero, no limit is imposed and all argument strings are returned. The values of the returned argument vector refer the strings stored in the .Vt procstat internal buffer. A subsequent call of the function with the same .Vt procstat argument will reuse the buffer. To free the allocated memory .Fn procstat_freeargv function call can be used, or it will be released on .Fn procstat_close . .Pp The .Fn procstat_getenvv function is similar to .Fn procstat_getargv but returns the vector of environment strings. The caller may free the allocated memory with a subsequent .Fn procstat_freeenv function call. .Pp The .Fn procstat_getauxv function gets a pointer to the .Vt procstat structure, a pointer to .Vt kinfo_proc structure, and returns the auxiliary vector as a dynamically allocated array of .Vt Elf_Auxinfo elements. The caller is responsible to free the allocated memory with a subsequent .Fn procstat_freeauxv function call. .Pp The .Fn procstat_getfiles function gets a pointer to the .Vt procstat structure initialized with one of the .Fn procstat_open_* functions, a pointer to .Vt kinfo_proc structure from the array obtained from the .Fn kvm_getprocs function, and returns a dynamically allocated linked list of filled in .Vt filestat_list structures using the STAILQ macros defined in .Xr queue 3 . The caller is responsible to free the allocated memory with a subsequent .Fn procstat_freefiles function call. .Pp The .Fn procstat_getgroups function gets a pointer to the .Vt procstat structure, a pointer to .Vt kinfo_proc structure, and returns the process groups as a dynamically allocated array of .Vt gid_t elements. The caller is responsible to free the allocated memory with a subsequent .Fn procstat_freegroups function call. .Pp The .Fn procstat_getkstack function gets a pointer to the .Vt procstat structure initialized with one of the .Fn procstat_open_* functions, a pointer to .Vt kinfo_proc structure, and returns kernel stacks of the process as a dynamically allocated array of .Vt kinfo_kstack structures. The caller is responsible to free the allocated memory with a subsequent .Fn procstat_freekstack function call. .Pp The .Fn procstat_getosrel function gets a pointer to the .Vt procstat structure, a pointer to .Vt kinfo_proc structure, and returns osrel date in the 3rd reference parameter. .Pp The .Fn procstat_getpathname function gets a pointer to the .Vt procstat structure, a pointer to .Vt kinfo_proc structure, and copies the path of the process executable to .Fa pathname buffer, limiting to .Fa maxlen characters. .Pp The .Fn procstat_getrlimit function gets a pointer to the .Vt procstat structure, a pointer to .Vt kinfo_proc structure, resource index .Fa which , and returns the actual resource limit in the 4th reference parameter. .Pp The .Fn procstat_getumask function gets a pointer to the .Vt procstat structure, a pointer to .Vt kinfo_proc structure, and returns the process umask in the 3rd reference parameter. .Pp The .Fn procstat_getvmmap function gets a pointer to the .Vt procstat structure initialized with one of the .Fn procstat_open_* functions, a pointer to .Vt kinfo_proc structure, and returns VM layout of the process as a dynamically allocated array of .Vt kinfo_vmentry structures. The caller is responsible to free the allocated memory with a subsequent .Fn procstat_freevmmap function call. .Pp The .Fn procstat_get_pipe_info , .Fn procstat_get_pts_info , .Fn procstat_get_sem_info , .Fn procstat_get_shm_info , .Fn procstat_get_socket_info and .Fn procstat_get_vnode_info functions are used to retrieve information about pipes, pseudo-terminals, semaphores, shared memory objects, sockets, and vnodes, respectively. Each of them have a similar interface API. The .Fa procstat argument is a pointer obtained from one of .Fn procstat_open_* functions. The .Ft filestat Fa fst argument is an element of STAILQ linked list as obtained from the .Fn procstat_getfiles function. The .Ft filestat structure contains a .Fa fs_type field that specifies a file type and a corresponding function to be called among the .Nm procstat_get_*_info function family. The actual object is returned in the 3rd reference parameter. The .Fa errbuf argument indicates an actual error message in case of failure. .Pp .Bl -tag -width 20n -compact -offset indent .It Li PS_FST_TYPE_FIFO .Nm procstat_get_vnode_info .It Li PS_FST_TYPE_VNODE .Nm procstat_get_vnode_info .It Li PS_FST_TYPE_SOCKET .Nm procstat_get_socket_info .It Li PS_FST_TYPE_PIPE .Nm procstat_get_pipe_info .It Li PS_FST_TYPE_PTS .Nm procstat_get_pts_info .It Li PS_FST_TYPE_SEM .Nm procstat_get_sem_info .It Li PS_FST_TYPE_SHM .Nm procstat_get_shm_info .El .Sh SEE ALSO .Xr fstat 1 , .Xr fuser 1 , .Xr pipe 2 , .Xr shm_open 2 , .Xr socket 2 , .Xr elf 3 , .Xr kvm 3 , .Xr queue 3 , .Xr sem_open 3 , .Xr sysctl 3 , .Xr pts 4 , .Xr core 5 , .Xr vnode 9 .Sh HISTORY The .Nm libprocstat library appeared in .Fx 9.0 . .Sh AUTHORS .An -nosplit The .Nm libprocstat library was written by .An Stanislav Sedov Aq Mt stas@FreeBSD.org . .Pp This manual page was written by .An Sergey Kandaurov Aq Mt pluknet@FreeBSD.org . Index: head/usr.bin/procstat/procstat.1 =================================================================== --- head/usr.bin/procstat/procstat.1 (revision 283166) +++ head/usr.bin/procstat/procstat.1 (revision 283167) @@ -1,550 +1,551 @@ .\"- .\" Copyright (c) 2007-2009 Robert N. M. Watson .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" -.Dd March 10, 2015 +.Dd May 18, 2015 .Dt PROCSTAT 1 .Os .Sh NAME .Nm procstat .Nd get detailed process information .Sh SYNOPSIS .Nm .Op Fl CHhn .Op Fl w Ar interval .Op Fl b | c | e | f | i | j | k | l | r | s | S | t | v | x .Op Fl a | Ar pid | Ar core ... .Sh DESCRIPTION The .Nm utility displays detailed information about the processes identified by the .Ar pid arguments, or if the .Fl a flag is used, all processes. It can also display information extracted from a process core file, if the core file is specified as the argument. .Pp By default, basic process statistics are printed; one of the following options may be specified in order to select more detailed process information for printing: .Bl -tag -width indent .It Fl b Display binary information for the process. .It Fl c Display command line arguments for the process. .It Fl e Display environment variables for the process. .It Fl f Display file descriptor information for the process. .It Fl i Display signal pending and disposition information for the process. .It Fl j Display signal pending and blocked information for the process's threads. .It Fl k 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. .It Fl l Display resource limits for the process. .It Fl r Display resource usage information for the process. .It Fl s Display security credential information for the process. .It Fl S Display the cpuset information for the thread. .It Fl t Display thread information for the process. .It Fl v Display virtual memory mappings for the process. .It Fl x Display ELF auxiliary vector for the process. .El .Pp All options generate output in the format of a table, the first field of which is the process ID to which the row of information corresponds. The .Fl h flag may be used to suppress table headers. .Pp The .Fl w flag may be used to specify a wait interval at which to repeat the printing of the requested process information. If the .Fl w flag is not specified, the output will not repeat. .Pp The .Fl C flag requests the printing of additional capability information in the file descriptor view. .Pp The .Fl H flag may be used to request per-thread statistics rather than per-process statistics for some options. For those options, the second field in the table will list the thread ID to which the row of information corresponds. The .Fl H flag is implied for the .Fl S mode. .Pp Information for VM, file descriptor, and cpuset options is available only to the owner of a process or the superuser. A cpuset value displayed as -1 means that the information is either invalid or not available. .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 OSREL osreldate for process binary .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 Environment Variables Display the process ID, command, and environment variables: .Pp .Bl -tag -width "ENVIRONMENT" -compact .It PID process ID .It COMM command .It ENVIRONMENT environment variables (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. By default, the following information will be printed: .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 e POSIX semaphore .It f fifo .It h shared memory .It k kqueue .It m message queue .It p pipe .It s socket .It t pseudo-terminal master .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 d directory .It f fifo .It l symbolic link .It r regular file .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 .Pp If the .Fl C flag is specified, the vnode type, reference count, and offset fields will be omitted, and a new capabilities field will be included listing capabilities, as described in .Xr cap_rights_limit 2 , present for each capability descriptor. .Ss Signal Disposition Information Display signal pending and disposition for a process: .Pp .Bl -tag -width indent -compact .It PID process ID .It COMM command .It SIG signal name .It FLAGS process signal disposition details, three symbols .Bl -tag -width X -compact .It P if signal is pending in the global process queue, - otherwise .It I if signal delivery disposition is SIGIGN, - otherwise .It C if signal delivery is to catch it, - otherwise .El .El .Pp If .Fl n switch is given, the signal numbers are shown instead of signal names. .Ss Thread Signal Information Display signal pending and blocked for a process's threads: .Pp .Bl -tag -width indent -compact .It PID process ID .It TID thread ID .It COMM command .It SIG signal name .It FLAGS thread signal delivery status, two symbols .Bl -tag -width X -compact .It P if signal is pending for the thread, - otherwise .It B if signal is blocked in the thread signal mask, - if not blocked .El .El .Pp The .Fl n switch has the same effect as for the .Fl i switch: the signal numbers are shown instead of signal names. .Ss Kernel Thread Stacks Display kernel thread stacks for a process, allowing further interpretation of thread wait channels. If the .Fl k flag is repeated, 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 Resource Limits Display resource limits for a process: .Pp .Bl -tag -width indent -compact .It PID process ID .It COMM command .It RLIMIT resource limit name .It SOFT soft limit .It HARD hard limit .El .Ss Resource Usage Display resource usage for a process. If the .Fl H flag is specified, resource usage for individual threads is displayed instead. .Pp .Bl -tag -width "RESOURCE" -compact .It PID process ID .It TID thread ID .Po if .Fl H is specified .Pc .It COMM command .It RESOURCE resource name .It VALUE current usage .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 UMASK file creation mode mask .It FLAGS credential flags .It GROUPS group set .El .Pp The following credential flags may be displayed: .Pp .Bl -tag -width X -compact .It C capability mode .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 FLAG 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 md device with managed pages .Pq GEM/TTM .It ph physical .It sg scatter/gather .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 .It S one or more superpage mappings are used .It D grows down (top-down stack) .It U grows up (bottom-up stack) .El .Ss ELF Auxiliary Vector Display ELF auxiliary vector values: .Pp .Bl -tag -width indent -compact .It PID process ID .It COMM command .It AUXV auxiliary vector name .It VALUE auxiliary vector value .El .Sh EXIT STATUS .Ex -std .Sh SEE ALSO .Xr fstat 1 , .Xr ps 1 , .Xr sockstat 1 , .Xr cap_enter 2 , .Xr cap_rights_limit 2 , +.Xr libprocstat 3 , .Xr ddb 4 , .Xr stack 9 .Sh AUTHORS .An Robert N M Watson .Sh BUGS Some field values may include spaces, which limits the extent to which the output of .Nm may be mechanically parsed. .Pp The display of open file or memory mapping pathnames is implemented using the kernel's name cache. If a file system does not use the name cache, or the path to a file is not in the cache, a path will not be displayed. .Pp .Nm currently supports extracting data only from a live kernel, and not from kernel crash dumps.