1.\" Copyright (c) 1987, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)fstat.1 8.3 (Berkeley) 2/25/94 29.\" $FreeBSD: src/usr.bin/fstat/fstat.1,v 1.9.2.7 2002/06/21 15:26:59 charnier Exp $ 30.\" $DragonFly: src/usr.bin/fstat/fstat.1,v 1.7 2008/09/02 11:50:45 matthias Exp $ 31.\" 32.Dd September 2, 2008 33.Dt FSTAT 1 34.Os 35.Sh NAME 36.Nm fstat 37.Nd file status 38.Sh SYNOPSIS 39.Nm 40.Op Fl fmnvw 41.Op Fl M Ar core 42.Op Fl N Ar system 43.Op Fl p Ar pid 44.Op Fl u Ar user 45.Op Ar 46.Sh DESCRIPTION 47The 48.Nm 49utility identifies open files. 50A file is considered open by a process if it was explicitly opened, 51is the working directory, root directory, active executable text, or kernel 52trace file for that process. 53If no options are specified, 54.Nm 55reports on all open files in the system. 56.Pp 57Options: 58.Bl -tag -width Ds 59.It Fl f 60Restrict examination to files open in the same filesystems as 61the named file arguments, or to the filesystem containing the 62current directory if there are no additional filename arguments. 63For example, to find all files open in the filesystem where the 64directory 65.Pa /usr/src 66resides, type 67.Dq Li fstat -f /usr/src . 68.It Fl M 69Extract values associated with the name list from the specified core 70instead of the default 71.Pa /dev/kmem . 72.It Fl N 73Extract the name list from the specified system instead of the default 74.Pa /boot/kernel . 75.It Fl m 76Include memory-mapped files in the listing; normally these are excluded 77due to the extra processing required. 78.It Fl n 79Numerical format. Print the device number (maj,min) of the filesystem 80the file resides in rather than the mount point name; for special 81files, print the 82device number that the special device refers to rather than the filename 83in 84.Pa /dev ; 85and print the mode of the file in octal instead of symbolic form. 86.It Fl p 87Report all files open by the specified process. 88.It Fl u 89Report all files open by the specified user. 90.It Fl v 91Verbose mode. Print error messages upon failures to locate particular 92system data structures rather than silently ignoring them. Most of 93these data structures are dynamically created or deleted and it is 94possible for them to disappear while 95.Nm 96is running. This 97is normal and unavoidable since the rest of the system is running while 98.Nm 99itself is running. 100.It Fl w 101Wide mode. Use a wider field for command names and file paths. 102.It Ar 103Restrict reports to the specified files. 104.El 105.Pp 106The following fields are printed: 107.Bl -tag -width MOUNT 108.It Li USER 109The username of the owner of the process (effective uid). 110.It Li CMD 111The command name of the process. 112.It Li PID 113The process id. 114.It Li FD 115The file number in the per-process open file table or one of the following 116special names: 117.Pp 118.Bd -literal -offset indent -compact 119text - executable text inode 120wd - current working directory 121root - root inode 122tr - kernel trace file 123mmap - memory-mapped file 124.Ed 125.Pp 126If the file number is followed by an asterisk (``*''), the file is 127not an inode, but rather a socket, 128.Tn FIFO , 129or there is an error. 130In this case the remainder of the line doesn't 131correspond to the remaining headers -- the format of the line 132is described later under 133.Sx SOCKETS . 134.It Li PATH 135If the 136.Fl n 137flag wasn't specified, this header is present and is the 138pathname representing the file. If no path can be extracted, the mount 139point path will be displayed. 140.It Li DEV 141If the 142.Fl n 143flag is specified, this header is present and is the 144major/minor number of the device that this file resides in. 145.It Li INUM 146The inode number of the file. 147.It Li MODE 148The mode of the file. If the 149.Fl n 150flag isn't specified, the mode is printed 151using a symbolic format (see 152.Xr strmode 3 ) ; 153otherwise, the mode is printed 154as an octal number. 155.It Li SZ\&|DV 156If the file is not a character or block special, prints the size of 157the file in bytes. Otherwise, if the 158.Fl n 159flag is not specified, prints 160the name of the special file as located in 161.Pa /dev . 162If that cannot be 163located, or the 164.Fl n 165flag is specified, prints the major/minor device 166number that the special device refers to. 167.It Li R/W 168This column describes the access mode that the file allows. 169The letter ``r'' indicates open for reading; 170the letter ``w'' indicates open for writing. 171This field is useful when trying to find the processes that are 172preventing a filesystem from being down graded to read-only. 173.It Li NAME 174If filename arguments are specified and the 175.Fl f 176flag is not, then 177this field is present and is the name associated with the given file. 178Normally the name cannot be determined since there is no mapping 179from an open file back to the directory entry that was used to open 180that file. Also, since different directory entries may reference 181the same file (via 182.Xr ln 1 ) , 183the name printed may not be the actual 184name that the process originally used to open that file. 185.El 186.Sh SOCKETS 187The formatting of open sockets depends on the protocol domain. 188In all cases the first field is the domain name, the second field 189is the socket type (stream, dgram, etc), and the third is the socket 190flags field (in hex). 191The remaining fields are protocol dependent. 192For tcp, it is the address of the tcpcb, and for udp, the inpcb (socket pcb). 193For unix domain sockets, its the address of the socket pcb and the address 194of the connected pcb (if connected). 195Otherwise the protocol number and address of the socket itself are printed. 196The attempt is to make enough information available to 197permit further analysis without duplicating 198.Xr netstat 1 . 199.Pp 200For example, the addresses mentioned above are the addresses which the 201.Dq Li netstat -A 202command would print for tcp, udp, and unixdomain. 203Note that since pipes are implemented using sockets, a pipe appears as a 204connected unix domain stream socket. 205A unidirectional unix domain socket indicates the direction of flow with 206an arrow (``<-'' or ``->''), and a full duplex socket shows a double arrow 207(``<->''). 208.Sh SEE ALSO 209.Xr netstat 1 , 210.Xr nfsstat 1 , 211.Xr ps 1 , 212.Xr sockstat 1 , 213.Xr systat 1 , 214.Xr tcp 4 , 215.Xr unix 4 , 216.Xr iostat 8 , 217.Xr pstat 8 , 218.Xr vmstat 8 219.Sh HISTORY 220The 221.Nm 222command appeared in 223.Bx 4.3 tahoe . 224.Sh BUGS 225Since 226.Nm 227takes a snapshot of the system, it is only correct for a very short period 228of time. 229