Annotation of src/usr.bin/fstat/fstat.1, Revision 1.49
1.49 ! jmc 1: .\" $OpenBSD: fstat.1,v 1.48 2012/01/07 05:38:12 guenther Exp $
1.16 aaron 2: .\"
1.1 deraadt 3: .\" Copyright (c) 1987, 1991, 1993
4: .\" The Regents of the University of California. All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
1.25 millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 15: .\" may be used to endorse or promote products derived from this software
16: .\" without specific prior written permission.
17: .\"
18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28: .\" SUCH DAMAGE.
29: .\"
30: .\" from: @(#)fstat.1 8.3 (Berkeley) 2/25/94
31: .\"
1.49 ! jmc 32: .Dd $Mdocdate: January 7 2012 $
1.1 deraadt 33: .Dt FSTAT 1
1.11 aaron 34: .Os
1.1 deraadt 35: .Sh NAME
36: .Nm fstat
1.15 pjanzen 37: .Nd display status of open files
1.1 deraadt 38: .Sh SYNOPSIS
39: .Nm fstat
1.36 mickey 40: .Op Fl fnosv
1.1 deraadt 41: .Op Fl M Ar core
42: .Op Fl N Ar system
43: .Op Fl p Ar pid
44: .Op Fl u Ar user
1.41 millert 45: .Op Ar
1.1 deraadt 46: .Sh DESCRIPTION
1.19 aaron 47: .Nm
1.1 deraadt 48: identifies open files.
49: A file is considered open by a process if it was explicitly opened,
1.42 millert 50: is the working directory, root directory, active executable text, or kernel
1.1 deraadt 51: trace file for that process.
52: If no options are specified,
1.19 aaron 53: .Nm
1.1 deraadt 54: reports on all open files in the system.
55: .Pp
1.14 aaron 56: The options are as follows:
1.1 deraadt 57: .Bl -tag -width Ds
58: .It Fl f
1.16 aaron 59: Restrict examination to files open in the same file systems as
60: the named file arguments, or to the file system containing the
1.1 deraadt 61: current directory if there are no additional filename arguments.
1.16 aaron 62: For example, to find all files open in the file system where the
1.1 deraadt 63: directory
64: .Pa /usr/src
65: resides, type
1.28 deraadt 66: .Pp
1.31 jmc 67: .Dl # fstat -f /usr/src
1.12 deraadt 68: .It Fl M Ar core
1.1 deraadt 69: Extract values associated with the name list from the specified core
1.20 miod 70: instead of the running kernel.
1.12 deraadt 71: .It Fl N Ar system
1.20 miod 72: Extract the name list from the specified system instead of the running kernel.
1.1 deraadt 73: .It Fl n
1.16 aaron 74: Numerical format.
75: Print the device number (maj,min) of the file system
1.17 aaron 76: the file resides in rather than the mount point name.
77: For special files, print the
1.1 deraadt 78: device number that the special device refers to rather than the filename
79: in
1.16 aaron 80: .Pa /dev .
81: Also, print the mode of the file in octal instead of symbolic form.
1.18 hugh 82: .It Fl o
83: Output file offset.
84: Follow the size field with the descriptor's offset.
85: Useful for checking progress as a process works through a large file.
1.39 deraadt 86: This information is only visible to the user or superuser.
1.19 aaron 87: .It Fl p Ar pid
1.1 deraadt 88: Report all files open by the specified process.
1.36 mickey 89: .It Fl s
90: Report per file io statistics in two additional columns
91: .Sq XFERS
92: and
93: .Sq KBYTES .
1.39 deraadt 94: This information is only visible to the user or superuser.
1.19 aaron 95: .It Fl u Ar user
1.1 deraadt 96: Report all files open by the specified user.
97: .It Fl v
1.16 aaron 98: Verbose mode.
99: Print error messages upon failures to locate particular
100: system data structures rather than silently ignoring them.
101: Most of these data structures are dynamically created or deleted and it is
1.1 deraadt 102: possible for them to disappear while
1.19 aaron 103: .Nm
1.16 aaron 104: is running.
1.17 aaron 105: This is normal and unavoidable since the rest of the system is running while
1.19 aaron 106: .Nm
1.1 deraadt 107: itself is running.
1.43 sobrado 108: .It Ar
1.1 deraadt 109: Restrict reports to the specified files.
110: .El
111: .Pp
112: The following fields are printed:
113: .Bl -tag -width MOUNT
114: .It Li USER
1.10 aaron 115: The username of the owner of the process (effective UID).
1.1 deraadt 116: .It Li CMD
117: The command name of the process.
118: .It Li PID
1.10 aaron 119: The process ID.
1.1 deraadt 120: .It Li FD
121: The file number in the per-process open file table or one of the following
122: special names:
1.29 otto 123: .Bd -literal -offset indent
1.42 millert 124: text \- executable text inode
1.26 jmc 125: wd \- current working directory
126: root \- root inode
127: tr \- kernel trace file
1.1 deraadt 128: .Ed
129: .Pp
1.16 aaron 130: If the file number is followed by an asterisk
131: .Pq Ql * ,
1.33 pedro 132: the file is not an inode, but rather a socket, or there is an error.
1.1 deraadt 133: In this case the remainder of the line doesn't
134: correspond to the remaining headers -- the format of the line
135: is described later under
1.27 jmc 136: .Sx SOCKETS .
1.1 deraadt 137: .It Li MOUNT
138: If the
139: .Fl n
140: flag wasn't specified, this header is present and is the
1.16 aaron 141: pathname that the file system the file resides in is mounted on.
1.1 deraadt 142: .It Li DEV
143: If the
144: .Fl n
145: flag is specified, this header is present and is the
146: major/minor number of the device that this file resides in.
147: .It Li INUM
148: The inode number of the file.
149: .It Li MODE
1.17 aaron 150: The mode of the file.
151: If the
1.1 deraadt 152: .Fl n
153: flag isn't specified, the mode is printed
154: using a symbolic format (see
155: .Xr strmode 3 ) ;
156: otherwise, the mode is printed
157: as an octal number.
1.38 sobrado 158: .It Li R/W
159: This column describes the access mode that the file allows.
160: The letter
161: .Sq r
162: indicates open for reading;
163: the letter
164: .Sq w
165: indicates open for writing.
166: This field is useful when trying to find the processes that are
167: preventing a file system from being downgraded to read-only.
1.46 jmc 168: .It Li SZ | DV
1.10 aaron 169: If the file is not a character or block special file, prints the size of
1.16 aaron 170: the file in bytes.
171: Otherwise, if the
1.1 deraadt 172: .Fl n
173: flag is not specified, prints
174: the name of the special file as located in
175: .Pa /dev .
1.16 aaron 176: If that cannot be located, or the
1.1 deraadt 177: .Fl n
178: flag is specified, prints the major/minor device
179: number that the special device refers to.
180: .It Li NAME
181: If filename arguments are specified and the
182: .Fl f
183: flag is not, then
184: this field is present and is the name associated with the given file.
185: Normally the name cannot be determined since there is no mapping
186: from an open file back to the directory entry that was used to open
1.16 aaron 187: that file.
188: Also, since different directory entries may reference
1.1 deraadt 189: the same file (via
1.24 jmc 190: .Xr ln 1 ) ,
1.1 deraadt 191: the name printed may not be the actual
192: name that the process originally used to open that file.
1.36 mickey 193: .It Li XFERS
1.47 jmc 194: Displays number of total data transfers performed on the file.
1.36 mickey 195: .It Li KBYTES
196: Displays total number of Kbytes written and read to the file.
1.1 deraadt 197: .El
198: .Sh SOCKETS
1.13 alex 199: The formatting of open sockets depends on the protocol domain.
1.40 jmc 200: In all cases the first field is the domain name
201: and the second field is the socket type (stream, dgram, etc).
1.1 deraadt 202: The remaining fields are protocol dependent.
1.10 aaron 203: For TCP, it is the address of the tcpcb, and for UDP, the inpcb (socket pcb).
1.44 sobrado 204: For
1.45 sobrado 205: .Ux Ns -domain
206: sockets, it's the address of the socket pcb and the address
1.1 deraadt 207: of the connected pcb (if connected).
208: Otherwise the protocol number and address of the socket itself are printed.
1.11 aaron 209: The attempt is to make enough information available to
1.1 deraadt 210: permit further analysis without duplicating
211: .Xr netstat 1 .
212: .Pp
213: For example, the addresses mentioned above are the addresses which the
1.16 aaron 214: .Ic netstat -A
1.44 sobrado 215: command would print for TCP, UDP, and
1.45 sobrado 216: .Ux Ns -domain.
1.44 sobrado 217: A unidirectional
1.45 sobrado 218: .Ux Ns -domain
219: socket indicates the direction of flow with
1.16 aaron 220: an arrow
221: .Pf ( Dq <-
222: or
223: .Dq -> ) ,
224: and a full duplex socket shows a double arrow
1.26 jmc 225: .Pq Dq <-> .
1.4 deraadt 226: .Pp
1.19 aaron 227: For
228: .Dv AF_INET
1.48 guenther 229: and
230: .Dv AF_INET6
1.19 aaron 231: sockets,
232: .Nm
1.4 deraadt 233: also attempts to print the internet address and port for the
234: local end of a connection.
235: If the socket is connected, it also prints the remote internet address
236: and port.
1.16 aaron 237: A
238: .Ql *
239: is used to indicate an
240: .Dv INADDR_ANY
241: binding.
242: In this case, the
243: use of the arrow
244: .Pf ( Dq <--
245: or
246: .Dq --> )
247: indicates the direction the socket connection was created.
1.48 guenther 248: .Pp
1.49 ! jmc 249: If the socket has been spliced to or from another socket (c.f.\&
1.48 guenther 250: .Xr setsockopt 2
251: and
1.49 ! jmc 252: .Dv SO_SPLICE )
! 253: then
1.48 guenther 254: .Nm
255: prints a thick arrow
256: .Pf ( Dq <==> ,
257: .Dq <== ,
258: or
259: .Dq ==> ) ,
260: followed by the address and endpoint information of the other socket
261: in the splice,
262: if available.
1.8 art 263: .Sh PIPES
264: Every pipe is printed as an address which is the same for both sides of
1.16 aaron 265: the pipe and a state that is built of the letters
266: .Dq RWE .
1.26 jmc 267: W \- The pipe blocks waiting for the reader to read data.
268: R \- The pipe blocks waiting for the writer to write data.
269: E \- The pipe is in EOF state.
1.21 deraadt 270: .Sh CRYPTO
1.22 deraadt 271: Each
272: .Xr crypto 4
273: device is printed with only the kernel address of the device private data.
1.21 deraadt 274: .Sh KQUEUE
1.22 deraadt 275: Each
276: .Xr kqueue 2
277: is printed with some information as to queue length.
1.23 avsm 278: Since these things are normally serviced quickly, it is likely that
1.21 deraadt 279: nothing of real importance can be discerned.
280: .Sh SYSTRACE
1.34 jmc 281: Each
282: .Xr systrace 4
283: device is printed with only the kernel address of the
1.21 deraadt 284: device private data.
1.1 deraadt 285: .Sh SEE ALSO
286: .Xr netstat 1 ,
287: .Xr nfsstat 1 ,
288: .Xr ps 1 ,
289: .Xr systat 1 ,
1.32 jmc 290: .Xr top 1 ,
1.1 deraadt 291: .Xr iostat 8 ,
292: .Xr pstat 8 ,
1.30 jmc 293: .Xr tcpdrop 8 ,
1.1 deraadt 294: .Xr vmstat 8
295: .Sh HISTORY
296: The
297: .Nm
298: command appeared in
299: .Bx 4.3 tahoe .
1.29 otto 300: .Sh CAVEATS
301: Sockets in use by the kernel, such as those opened by
302: .Xr nfsd 8 ,
303: will not be seen by
304: .Nm ,
305: even though they appear in
306: .Xr netstat 1 .
1.19 aaron 307: .Sh BUGS
308: Since
309: .Nm
310: takes a snapshot of the system, it is only correct for a very short period
311: of time.
312: .Pp
313: Moreover, because DNS resolution and YP lookups cause many file
314: descriptor changes,
315: .Nm
316: does not attempt to translate the internet address and port numbers into
317: symbolic names.
![[BACK]](/icons/back.gif){kind=icon}
Return to fstat.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / fstat