1 .\" Copyright (c) 1987, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
28 .\" @(#)fstat.1 8.3 (Berkeley) 2/25/94
36 .Nd identify active files
48 utility identifies open files.
49 A file is considered open by a process if it was explicitly opened,
50 is the working directory, root directory, jail root directory,
51 active executable text, or kernel trace file for that process.
52 If no options are specified,
54 reports on all open files in the system for processes the user has access to.
56 The following options are available:
57 .Bl -tag -width "-N system"
59 Restrict examination to files open in the same file systems as
60 the named file arguments, or to the file system containing the
61 current directory if there are no additional filename arguments.
62 For example, to find all files open in the file system where the
66 .Ql fstat -f /usr/src .
68 Extract values associated with the name list from the specified core
69 instead of the default
72 Include memory-mapped files in the listing; normally these are excluded
73 due to the extra processing required.
75 Extract the name list from the specified system instead of the default,
76 which is the kernel image the system has booted from.
79 Print the device number (maj,min) of the file system
80 the file resides in rather than the mount point name; for special
82 device number that the special device refers to rather than the filename
85 and print the mode of the file in octal instead of symbolic form.
87 Report all files open by the specified process.
89 Print socket endpoint information.
91 Report all files open by the specified user.
94 Print error messages upon failures to locate particular
95 system data structures rather than silently ignoring them.
97 these data structures are dynamically created or deleted and it is
98 possible for them to disappear while
102 is normal and unavoidable since the rest of the system is running while
106 Restrict reports to the specified files.
109 The following fields are printed:
110 .Bl -tag -width MOUNT
112 The username of the owner of the process (effective uid).
114 The command name of the process.
118 The file number in the per-process open file table or one of the following
121 .Bl -tag -width jail -offset indent -compact
129 executable text inode
133 current working directory
136 If the file number is followed by an asterisk
139 not an inode, but rather a socket, FIFO, or there is an error.
140 In this case the remainder of the line does not
141 correspond to the remaining headers\(em the format of the line
142 is described later under
147 flag was not specified, this header is present and is the
148 pathname that the file system the file resides in is mounted on.
152 flag is specified, this header is present and is the
153 number of the device that this file resides in.
155 The inode number of the file.
157 The mode of the file.
160 flag is not specified, the mode is printed
161 using a symbolic format (see
163 otherwise, the mode is printed
166 If the file is a semaphore,
167 prints the current value of the semaphore.
168 If the file is not a character or block special, prints the size of
172 flag is not specified, prints
173 the name of the special file as located in
178 flag is specified, prints the major/minor device
179 number that the special device refers to.
181 This column describes the access mode that the file allows.
184 indicates open for reading;
187 indicates open for writing.
188 This field is useful when trying to find the processes that are
189 preventing a file system from being down graded to read-only.
191 If filename arguments are specified and the
194 this field is present and is the name associated with the given file.
195 Normally the name cannot be determined since there is no mapping
196 from an open file back to the directory entry that was used to open
198 Also, since different directory entries may reference
201 the name printed may not be the actual
202 name that the process originally used to open that file.
205 The formatting of open sockets depends on the protocol domain.
206 In all cases the first field is the domain name, the second field
207 is the socket type (stream, dgram, etc.), and the third is the socket
208 flags field (in hex).
209 The remaining fields are protocol dependent.
210 For TCP, it is the address of the tcpcb, and for UDP, the inpcb (socket pcb).
211 For UNIX-domain sockets, its the address of the socket pcb and the address
212 of the connected pcb (if connected).
213 Otherwise the protocol number and address of the socket itself are printed.
215 For example, the addresses mentioned above are the addresses which the
217 command would print for TCP, UDP, and UNIX-domain.
218 Note that since pipes are implemented using sockets, a pipe appears as a
219 connected UNIX-domain stream socket.
220 A unidirectional UNIX-domain socket indicates the direction of flow with
226 and a full duplex socket shows a double arrow
231 flag is used, socket endpoint information is shown after the address of the
233 For internet sockets the local and remote addresses are shown, separated with
236 For UNIX/local sockets either the local or remote address is shown, depending
237 on which one is available.
241 Show all open files except those opened by
244 .Bd -literal -offset indent
245 $ fstat | awk '$2 != "fstat"'
246 USER CMD PID FD MOUNT INUM MODE SZ|DV R/W
247 alice bash 469 text /usr/local 143355 -rwxr-xr-x 1166448 r
248 alice bash 469 ctty /dev 346 crw--w---- pts/81 rw
252 Report all files opened by the current shell in the same file system as
254 including memory-mapped files:
255 .Bd -literal -offset indent
256 $ fstat -m -p $$ -f /usr/local
257 USER CMD PID FD MOUNT INUM MODE SZ|DV R/W
258 bob bash 469 text /usr/local 143355 -rwxr-xr-x 1166448 r
259 bob bash 469 mmap /usr/local 143355 -rwxr-xr-x 1166448 r
263 Requesting information about a file that is not opened results in just a
264 header line instead of an error:
265 .Bd -literal -offset indent
267 USER CMD PID FD MOUNT INUM MODE SZ|DV R/W NAME
272 will be interpreted as files, so the following will not work as expected:
273 .Bd -literal -offset indent
274 $ fstat -f /usr/local -m -p $$
275 fstat: -m: No such file or directory
276 fstat: -p: No such file or directory
277 fstat: 469: No such file or directory
281 Show number of pipes opened by firefox processes:
282 .Bd -literal -offset indent
283 $ fstat | awk '$2=="firefox" && $5=="pipe"' | wc -l
286 Show processes belonging to user
288 whose standard error descriptor is opened in ttyv0:
289 .Bd -literal -offset indent
290 $ fstat -u bob | awk '$4 == 2 && $8 == "ttyv0"'
291 bob firefox 77842 2 /dev 103 crw------- ttyv0 rw
292 bob xinit 1194 2 /dev 103 crw------- ttyv0 rw
296 Show opened TCP sockets.
297 This output resembles the one produced by
298 .Ql netstat -A -p tcp
300 .Bd -literal -offset indent
301 $ fstat | awk '$7 == "tcp"'
302 alice firefox 77991 32* internet stream tcp fffff800b7f147a0
303 alice firefox 77991 137* internet stream tcp fffff800b7f12b70
307 Show a list of processes with files opened in the current directory
308 mimicking the output of
311 .Bd -literal -offset indent
312 $ fstat . | awk 'NR > 1 {printf "%d%s(%s) ", $3, $4, $1;}'
313 2133wd(alice) 2132wd(alice) 1991wd(alice)
316 Create a list of processes sorted by number of opened files in desdencing order:
317 .Bd -literal -offset indent
318 $ fstat | awk 'NR > 1 {print $2;}' | sort | uniq -c | sort -r
346 takes a snapshot of the system, it is only correct for a very short period