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