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$ 34.\" 35.Dd February 25, 1994 36.Dt FSTAT 1 37.Os BSD 4 38.Sh NAME 39.Nm fstat 40.Nd file status 41.Sh SYNOPSIS 42.Nm fstat 43.Op Fl fnv 44.Op Fl M Ar core 45.Op Fl N Ar system 46.Op Fl p Ar pid 47.Op Fl u Ar user 48.Op Ar filename... 49.Sh DESCRIPTION 50.Nm Fstat 51identifies open files. 52A file is considered open by a process if it was explicitly opened, 53is the working directory, root directory, active executable text, or kernel 54trace file for that process. 55If no options are specified, 56.Nm fstat 57reports on all open files in the system. 58.Pp 59Options: 60.Bl -tag -width Ds 61.It Fl f 62Restrict examination to files open in the same filesystems as 63the named file arguments, or to the filesystem containing the 64current directory if there are no additional filename arguments. 65For example, to find all files open in the filesystem where the 66directory 67.Pa /usr/src 68resides, type 69.Dq Li fstat -f /usr/src . 70.It Fl M 71Extract values associated with the name list from the specified core 72instead of the default 73.Pa /dev/kmem . 74.It Fl N 75Extract the name list from the specified system instead of the default 76.Pa /kernel . 77.It Fl n 78Numerical format. Print the device number (maj,min) of the filesystem 79the file resides in rather than the mount point name; for special 80files, print the 81device number that the special device refers to rather than the filename 82in 83.Pa /dev ; 84and print the mode of the file in octal instead of symbolic form. 85.It Fl p 86Report all files open by the specified process. 87.It Fl u 88Report all files open by the specified user. 89.It Fl v 90Verbose mode. Print error messages upon failures to locate particular 91system data structures rather than silently ignoring them. Most of 92these data structures are dynamically created or deleted and it is 93possible for them to disappear while 94.Nm fstat 95is running. This 96is normal and unavoidable since the rest of the system is running while 97.Nm fstat 98itself is running. 99.It Ar filename ... 100Restrict reports to the specified files. 101.El 102.Pp 103The following fields are printed: 104.Bl -tag -width MOUNT 105.It Li USER 106The username of the owner of the process (effective uid). 107.It Li CMD 108The command name of the process. 109.It Li PID 110The process id. 111.It Li FD 112The file number in the per-process open file table or one of the following 113special names: 114.Pp 115.Bd -literal -ragged -offset indent -compact 116text - executable text inode 117wd - current working directory 118root - root inode 119tr - kernel trace file 120.Ed 121.Pp 122If the file number is followed by an asterisk (``*''), the file is 123not an inode, but rather a socket, 124.Tn FIFO , 125or there is an error. 126In this case the remainder of the line doesn't 127correspond to the remaining headers -- the format of the line 128is described later under 129.Sx Sockets . 130.It Li MOUNT 131If the 132.Fl n 133flag wasn't specified, this header is present and is the 134pathname that the filesystem the file resides in is mounted on. 135.It Li DEV 136If the 137.Fl n 138flag is specified, this header is present and is the 139major/minor number of the device that this file resides in. 140.It Li INUM 141The inode number of the file. 142.It Li MODE 143The mode of the file. If the 144.Fl n 145flag isn't specified, the mode is printed 146using a symbolic format (see 147.Xr strmode 3 ) ; 148otherwise, the mode is printed 149as an octal number. 150.It Li SZ\&|DV 151If the file is not a character or block special, prints the size of 152the file in bytes. Otherwise, if the 153.Fl n 154flag is not specified, prints 155the name of the special file as located in 156.Pa /dev . 157If that cannot be 158located, or the 159.Fl n 160flag is specified, prints the major/minor device 161number that the special device refers to. 162.It Li R/W 163This column describes the access mode that the file allows. 164The letter ``r'' indicates open for reading; 165the letter ``w'' indicates open for writing. 166This field is useful when trying to find the processes that are 167preventing a filesystem from being down graded to read-only. 168.It Li NAME 169If filename arguments are specified and the 170.Fl f 171flag is not, then 172this field is present and is the name associated with the given file. 173Normally the name cannot be determined since there is no mapping 174from an open file back to the directory entry that was used to open 175that file. Also, since different directory entries may reference 176the same file (via 177.Xr ln 1 ) , 178the name printed may not be the actual 179name that the process originally used to open that file. 180.El 181.Sh SOCKETS 182The formating of open sockets depends on the protocol domain. 183In all cases the first field is the domain name, the second field 184is the socket type (stream, dgram, etc), and the third is the socket 185flags field (in hex). 186The remaining fields are protocol dependent. 187For tcp, it is the address of the tcpcb, and for udp, the inpcb (socket pcb). 188For unix domain sockets, its the address of the socket pcb and the address 189of the connected pcb (if connected). 190Otherwise the protocol number and address of the socket itself are printed. 191The attempt is to make enough information available to 192permit further analysis without duplicating 193.Xr netstat 1 . 194.Pp 195For example, the addresses mentioned above are the addresses which the 196.Dq Li netstat -A 197command would print for tcp, udp, and unixdomain. 198Note that since pipes are implemented using sockets, a pipe appears as a 199connected unix domain stream socket. 200A unidirectional unix domain socket indicates the direction of flow with 201an arrow (``<-'' or ``->''), and a full duplex socket shows a double arrow 202(``<->''). 203.Sh BUGS 204Since 205.Nm fstat 206takes a snapshot of the system, it is only correct for a very short period 207of time. 208.Sh SEE ALSO 209.Xr netstat 1 , 210.Xr nfsstat 1 , 211.Xr ps 1 , 212.Xr systat 1 , 213.Xr iostat 8 , 214.Xr pstat 8 , 215.Xr vmstat 8 216.Sh HISTORY 217The 218.Nm 219command appeared in 220.Bx 4.3 tahoe . 221