| blob | fce7a1bf64d052393d1a0f36da9c0492a3e4e9d4 |
1 '\" te
2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH FSSTAT 1M "Jan 5, 2007"
7 .SH NAME
8 fsstat \- report file system statistics
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBfsstat\fR [\fB-a|f|i|n|v\fR] [\fB-T\fR | u|d] {\fB-F\fR | {\fIfstype\fR|\fIpath\fR}...}
13 [\fIinterval\fR [\fIcount\fR]]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 \fBfsstat\fR reports kernel file operation activity by the file system type
20 (\fIfstype\fR) or by the path name, which is converted to a mount point. The
21 first set of lines of output reports all activity since:
22 .RS +4
23 .TP
24 .ie t \(bu
25 .el o
26 The file system module was loaded (in the case of \fIfstype\fR)
27 .RE
28 .RS +4
29 .TP
30 .ie t \(bu
31 .el o
32 The file system was mounted (in the case of mount point)
33 .RE
34 .sp
35 .LP
36 Statistics are gathered at the file system independent layer at both the
37 \fIfstype\fR and the mount point levels. However, not all file system types are
38 represented in the gathering of statistics. (See the NOTES section of this man
39 page.)
40 .sp
41 .LP
42 The output of \fBfsstat\fR is dependent on the mode (option) requested. All
43 statistic fields are displayed using "smart numbers" which automatically scale
44 the units in a human readable form that fits in a maximum of 5 characters. For
45 example:
46 .sp
47 .ne 2
48 .na
49 \fB100\fR
50 .ad
51 .RS 11n
52 is displayed as 100
53 .RE
55 .sp
56 .ne 2
57 .na
58 \fB2048\fR
59 .ad
60 .RS 11n
61 is displayed as 2K
62 .RE
64 .sp
65 .ne 2
66 .na
67 \fB3000000\fR
68 .ad
69 .RS 11n
70 is displayed as 2.86M
71 .RE
73 .sp
74 .LP
75 The unit modifiers are: K (Kbyte), M (Mbyte), G (Gbyte), T (terabyte), P
76 (petabyte), and E (exabyte).
77 .sp
78 .LP
79 During the execution of \fBfsstat\fR, the state of the system can change. If
80 relevant, a state change message is included in the \fBfsstat\fR output in one
81 of the following forms:
82 .sp
83 .in +2
84 .nf
85 <<mount point no longer available: {path}>>
86 <<file system module no longer loaded: {fstype}>>
87 .fi
88 .in -2
89 .sp
91 .sp
92 .LP
93 After the state change messages are displayed, \fBfsstat\fR continues to
94 display the statistics as directed. If all of the \fIfstypes\fR and mount
95 points that \fBfsstat\fR was reporting on are no longer available, then
96 \fBfsstat\fR exits.
97 .sp
98 .LP
99 The user is required to specify the \fB-F\fR option (all available file system
100 types) or a list of one or more \fIfstypes\fR and/or mount points.
101 .sp
102 .LP
103 The default report shows general file system activity. This display combines
104 similar operations into general categories as follows:
105 .sp
106 .ne 2
107 .na
108 \fBnew file\fR
109 .ad
110 .RS 15n
111 Number of creation operations for file system objects (for example, files,
112 directories, symlinks, etc.)
113 .RE
115 .sp
116 .ne 2
117 .na
118 \fBname remov\fR
119 .ad
120 .RS 15n
121 Number of name removal operations
122 .RE
124 .sp
125 .ne 2
126 .na
127 \fBname chng\fR
128 .ad
129 .RS 15n
130 Number of name change operations
131 .RE
133 .sp
134 .ne 2
135 .na
136 \fBattr get\fR
137 .ad
138 .RS 15n
139 Number of object attribute retrieval operations
140 .RE
142 .sp
143 .ne 2
144 .na
145 \fBattr set\fR
146 .ad
147 .RS 15n
148 Number of object attribute change operations
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fBlookup ops\fR
155 .ad
156 .RS 15n
157 Number of object lookup operations
158 .RE
160 .sp
161 .ne 2
162 .na
163 \fBrddir ops\fR
164 .ad
165 .RS 15n
166 Number of read directory operations
167 .RE
169 .sp
170 .ne 2
171 .na
172 \fBread ops\fR
173 .ad
174 .RS 15n
175 Number of data read operations
176 .RE
178 .sp
179 .ne 2
180 .na
181 \fBread bytes\fR
182 .ad
183 .RS 15n
184 Bytes transferred by data read operations
185 .RE
187 .sp
188 .ne 2
189 .na
190 \fBwrite ops\fR
191 .ad
192 .RS 15n
193 Number of data write operations
194 .RE
196 .sp
197 .ne 2
198 .na
199 \fBwrite bytes\fR
200 .ad
201 .RS 15n
202 Bytes transferred by data write operations
203 .RE
205 .sp
206 .LP
207 The entity being reported on (\fIfstype\fR or mount point) is displayed in the
208 last column.
209 .SH OPTIONS
210 .sp
211 .LP
212 The following options are supported:
213 .sp
214 .ne 2
215 .na
216 \fB\fB-a\fR\fR
217 .ad
218 .RS 10n
219 Report the activity for kernel attribute operations. The following statistics
220 are reported:
221 .sp
222 .ne 2
223 .na
224 \fBgetattr\fR
225 .ad
226 .RS 11n
227 Number of file attribute retrieval calls
228 .RE
230 .sp
231 .ne 2
232 .na
233 \fBsetattr\fR
234 .ad
235 .RS 11n
236 Number of file attribute modification calls
237 .RE
239 .sp
240 .ne 2
241 .na
242 \fBgetsec\fR
243 .ad
244 .RS 11n
245 Number of file security attribute retrieval calls
246 .RE
248 .sp
249 .ne 2
250 .na
251 \fBsetsec\fR
252 .ad
253 .RS 11n
254 Number of file security attribute modification calls
255 .RE
257 The entity being reported on (\fIfstype\fR or mount point) is displayed in the
258 last column.
259 .RE
261 .sp
262 .ne 2
263 .na
264 \fB\fB-f\fR\fR
265 .ad
266 .RS 10n
267 Report the full activity for all kernel file operations. Each file operation is
268 listed in the left column. The following statistics are reported for each
269 operation:
270 .sp
271 .ne 2
272 .na
273 \fB#ops\fR
274 .ad
275 .RS 9n
276 Number of calls for this operation
277 .RE
279 .sp
280 .ne 2
281 .na
282 \fBbytes\fR
283 .ad
284 .RS 9n
285 Average transfer size in bytes (only applies to read, write, readdir)
286 .RE
288 The entity being reported on (\fIfstype\fR or mount point) is displayed in the
289 first row.
290 .RE
292 .sp
293 .ne 2
294 .na
295 \fB\fB-i\fR\fR
296 .ad
297 .RS 10n
298 Reports the activity for kernel I/O operations. The following statistics are
299 reported:
300 .sp
301 .ne 2
302 .na
303 \fBread ops\fR
304 .ad
305 .RS 15n
306 Number of data read calls
307 .RE
309 .sp
310 .ne 2
311 .na
312 \fBread bytes\fR
313 .ad
314 .RS 15n
315 Number of bytes read
316 .RE
318 .sp
319 .ne 2
320 .na
321 \fBwrite ops\fR
322 .ad
323 .RS 15n
324 Number of data write calls
325 .RE
327 .sp
328 .ne 2
329 .na
330 \fBwrite bytes\fR
331 .ad
332 .RS 15n
333 Number of bytes written
334 .RE
336 .sp
337 .ne 2
338 .na
339 \fBrddir ops\fR
340 .ad
341 .RS 15n
342 Number of read directory calls
343 .RE
345 .sp
346 .ne 2
347 .na
348 \fBrddir bytes\fR
349 .ad
350 .RS 15n
351 Number of bytes read by reading directories
352 .RE
354 .sp
355 .ne 2
356 .na
357 \fBrwlock ops\fR
358 .ad
359 .RS 15n
360 Number of internal file system lock operations
361 .RE
363 .sp
364 .ne 2
365 .na
366 \fBrwulock ops\fR
367 .ad
368 .RS 15n
369 Number of internal file system unlock operations
370 .RE
372 The entity being reported on (\fIfstype\fR or mount point) is displayed in the
373 last column.
374 .RE
376 .sp
377 .ne 2
378 .na
379 \fB\fB-n\fR\fR
380 .ad
381 .RS 10n
382 Reports the activity for kernel naming operations. The following statistics are
383 reported:
384 .sp
385 .ne 2
386 .na
387 \fBlookup\fR
388 .ad
389 .RS 11n
390 Number of file name retrieval calls
391 .RE
393 .sp
394 .ne 2
395 .na
396 \fBcreat\fR
397 .ad
398 .RS 11n
399 Number of file creation calls
400 .RE
402 .sp
403 .ne 2
404 .na
405 \fBremov\fR
406 .ad
407 .RS 11n
408 Number of file remove calls
409 .RE
411 .sp
412 .ne 2
413 .na
414 \fBlink\fR
415 .ad
416 .RS 11n
417 Number of link calls
418 .RE
420 .sp
421 .ne 2
422 .na
423 \fBrenam\fR
424 .ad
425 .RS 11n
426 Number of file renaming calls
427 .RE
429 .sp
430 .ne 2
431 .na
432 \fBmkdir\fR
433 .ad
434 .RS 11n
435 Number of directory creation calls
436 .RE
438 .sp
439 .ne 2
440 .na
441 \fBrmdir\fR
442 .ad
443 .RS 11n
444 Number of directory removal calls
445 .RE
447 .sp
448 .ne 2
449 .na
450 \fBrddir\fR
451 .ad
452 .RS 11n
453 Number of directory read calls
454 .RE
456 .sp
457 .ne 2
458 .na
459 \fBsymlink\fR
460 .ad
461 .RS 11n
462 Number of symlink creation calls
463 .RE
465 .sp
466 .ne 2
467 .na
468 \fBrdlink\fR
469 .ad
470 .RS 11n
471 Number of symlink read calls
472 .RE
474 The entity being reported on (\fIfstype\fR or mount point) is displayed in the
475 last column.
476 .RE
478 .sp
479 .ne 2
480 .na
481 \fB\fB-v\fR\fR
482 .ad
483 .RS 10n
484 Reports the activity for calls to the virtual memory operations. The following
485 statistics are reported.
486 .sp
487 .ne 2
488 .na
489 \fBmap\fR
490 .ad
491 .RS 10n
492 Number of calls mapping a file
493 .RE
495 .sp
496 .ne 2
497 .na
498 \fBaddmap\fR
499 .ad
500 .RS 10n
501 Number of calls setting additional mapping to a mapped file
502 .RE
504 .sp
505 .ne 2
506 .na
507 \fBdelmap\fR
508 .ad
509 .RS 10n
510 Number of calls deleting mapping to a file
511 .RE
513 .sp
514 .ne 2
515 .na
516 \fBgetpag\fR
517 .ad
518 .RS 10n
519 Number of calls retrieving a page of data from a file
520 .RE
522 .sp
523 .ne 2
524 .na
525 \fBputpag\fR
526 .ad
527 .RS 10n
528 Number of calls writing a page of data to a file
529 .RE
531 .sp
532 .ne 2
533 .na
534 \fBpagio\fR
535 .ad
536 .RS 10n
537 Number of calls to transfer pages in file system swap files
538 .RE
540 The entity being reported on (fstype or mount point) is displayed in the last
541 column.
542 .RE
544 .sp
545 .ne 2
546 .na
547 \fB\fB-F\fR\fR
548 .ad
549 .RS 10n
550 Report on all available file system types.
551 .RE
553 .sp
554 .ne 2
555 .na
556 \fB\fB-T\fR \fIu\fR|\fId\fR\fR
557 .ad
558 .RS 10n
559 Display a time stamp.
560 .sp
561 Specify \fIu\fR for a printed representation of the internal representation of
562 time (see \fBtime\fR(2)) Specify \fId\fR for the standard date format. (See
563 \fBdate\fR(1)). The time stamp is only used when an interval is set.
564 .RE
566 .SH OPERANDS
567 .sp
568 .LP
569 The following operands are supported:
570 .sp
571 .ne 2
572 .na
573 \fB\fIcount\fR\fR
574 .ad
575 .RS 12n
576 Display only \fIcount\fR reports.
577 .RE
579 .sp
580 .ne 2
581 .na
582 \fB\fIfstype\fR\fR
583 .ad
584 .RS 12n
585 Explicitly specify the file system type(s) to be reported. The file system
586 module must be loaded.
587 .RE
589 .sp
590 .ne 2
591 .na
592 \fB\fIinterval\fR\fR
593 .ad
594 .RS 12n
595 Report once each \fIinterval\fR seconds.
596 .RE
598 .sp
599 .ne 2
600 .na
601 \fB\fIpath\fR\fR
602 .ad
603 .RS 12n
604 Specify the path(s) of the mount point(s) to be reported. If path is not a
605 mount point, the mount point containing path will be determined and displayed
606 in the output.
607 .RE
609 .sp
610 .LP
611 If no \fIinterval\fR and no \fIcount\fR are specified, a single report is
612 printed and \fBfsstat\fR exits. If an \fIinterval\fR is specified but no
613 \fIcount\fR is specified, \fBfsstat\fR prints reports every \fIinterval\fR
614 seconds indefinitely until the command is interrupted.
615 .SH EXAMPLES
616 .LP
617 \fBExample 1 \fRDisplaying General Activity
618 .sp
619 .LP
620 The following example shows general activity for all file system types.
622 .sp
623 .in +2
624 .nf
625 \fB$ fsstat -F\fR
626 new name name attr attr lookup rddir read read write write
627 file remov chng get set ops ops ops bytes ops bytes
628 313K 214K 38.5K 2.16M 56.2K 8.36M 52.8K 19.7M 39.9G 18.8M 39.1G ufs
629 0 0 0 2.95K 0 3.81K 282 2.52K 466K 0 0 proc
630 0 0 0 0 0 0 0 0 0 0 0 nfs
631 10 8 2 86 9 98 15 413 103M 8.43K 1.05G zfs
632 13 14 4 98 16 125 10 1.01K 258M 15.9K 127M lofs
633 8.73K 3.29K 5.25K 55.3K 37 1.20M 44 37.9K 38.3M 47.2K 35.9M tmpfs
634 0 0 0 4.93K 0 0 0 1.08K 913K 0 0 mntfs
635 3 2 1 503 3 897 13 122 25.8K 128 272K nfs3
636 10 8 0 615 10 10.1K 18 61 45.6K 292 2.26M nfs4
637 .fi
638 .in -2
639 .sp
641 .LP
642 \fBExample 2 \fRDisplaying Naming Activity
643 .sp
644 .LP
645 The following example shows the naming activity for ufs, nfs, nfs3, nfs4, and
646 tmpfs:
648 .sp
649 .in +2
650 .nf
651 \fB$ fsstat -n ufs nfs nfs3 nfs4 tmpfs\fR
652 lookup creat remov link renam mkdir rmdir rddir symlnk rdlnk
653 3.57M 3.10K 586 6 24 115 100 30.2K 5 330K ufs
654 0 0 0 0 0 0 0 0 0 0 nfs
655 18.3K 3 5 0 0 0 0 1.03K 2 346 nfs3
656 535 0 0 0 0 0 0 46 0 4 nfs4
657 146 24 15 0 0 4 0 4 0 0 tmpfs
658 .fi
659 .in -2
660 .sp
662 .LP
663 \fBExample 3 \fRDisplaying Attribute Activity
664 .sp
665 .LP
666 The following example shows the attribute activity for the FS type ufs and the
667 mounted file systems "/" and "/export/home" every three seconds for every third
668 iteration:
670 .sp
671 .in +2
672 .nf
673 \fB# fsstat -a ufs / /export/home 3 3\fR
674 getattr setattr getsec setsec
675 378K 91.9K 11.8K 0 ufs
676 367K 82.3K 11.6K 0 /
677 11.3K 9.6K 198 0 /export/home
678 4.97K 2.27K 163 0 ufs
679 3.94K 1.36K 162 0 /
680 1.03K 927 1 0 /export/home
681 2.30K 1.06K 73 0 ufs
682 1.95K 766 71 0 /
683 361 317 2 0 /export/home
684 2.33K 1.06K 78 0 ufs
685 1.64K 451 77 0 /
686 711 631 1 0 /export/home
687 .fi
688 .in -2
689 .sp
691 .LP
692 \fBExample 4 \fRDisplaying File Operation Statistics
693 .sp
694 .LP
695 The following example shows the statistics for each file operation for "/"
696 (using the \fB-f\fR option):
698 .sp
699 .in +2
700 .nf
701 \fB$ fsstat -f /\fR
702 Mountpoint: /
703 operation #ops bytes
704 open 8.54K
705 close 9.8K
706 read 43.6K 65.9M
707 write 1.57K 2.99M
708 ioctl 2.06K
709 setfl 4
710 getattr 40.3K
711 setattr 38
712 access 9.19K
713 lookup 203K
714 create 595
715 remove 56
716 link 0
717 rename 9
718 mkdir 19
719 rmdir 0
720 readdir 2.02K 2.27M
721 symlink 4
722 readlink 8.31K
723 fsync 199
724 inactive 2.96K
725 fid 0
726 rwlock 47.2K
727 rwunlock 47.2K
728 seek 29.1K
729 cmp 42.9K
730 frlock 4.45K
731 space 8
732 realvp 3.25K
733 getpage 104K
734 putpage 2.69K
735 map 13.2K
736 addmap 34.4K
737 delmap 33.4K
738 poll 287
739 dump 0
740 pathconf 54
741 pageio 0
742 dumpctl 0
743 dispose 23.8K
744 getsecattr 697
745 setsecattr 0
746 shrlock 0
747 vnevent 0
748 .fi
749 .in -2
750 .sp
752 .SH ENVIRONMENT VARIABLES
753 .sp
754 .LP
755 See \fBenviron\fR(5) for descriptions of the following environment variables
756 that affect the execution of \fBfsstat\fR: \fBLANG\fR, \fBLC_ALL\fR,
757 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBLC_TIME\fR, and \fBNLSPATH\fR.
758 .SH EXIT STATUS
759 .sp
760 .LP
761 The following exit values are returned:
762 .sp
763 .ne 2
764 .na
765 \fB\fB0\fR\fR
766 .ad
767 .RS 5n
768 Successful completion.
769 .RE
771 .sp
772 .ne 2
773 .na
774 \fB\fB1\fR\fR
775 .ad
776 .RS 5n
777 A fatal error occurred. A fatal error could be a failed system call or another
778 internal error.
779 .RE
781 .sp
782 .ne 2
783 .na
784 \fB\fB2\fR\fR
785 .ad
786 .RS 5n
787 Invalid command-line options were specified.
788 .RE
790 .SH ATTRIBUTES
791 .sp
792 .LP
793 See \fBattributes\fR(5) for descriptions of the following attributes:
794 .sp
796 .sp
797 .TS
798 box;
799 c | c
800 l | l .
801 ATTRIBUTE TYPE ATTRIBUTE VALUE
802 _
803 CSI Enabled
804 _
805 Interface Stability See below.
806 .TE
808 .sp
809 .LP
810 The command-line options are Unstable. The human-readable output is not
811 considered an interface.
812 .SH SEE ALSO
813 .sp
814 .LP
815 \fBdate\fR(1), \fBtime\fR(2), \fBattributes\fR(5)
816 .SH NOTES
817 .sp
818 .LP
819 All display options (\fB-a\fR, \fB-f\fR, \fB-i\fR, \fB-n\fR, \fB-v\fR) are
820 mutually exclusive. Entering more than one of these options will result in an
821 error.
822 .sp
823 .LP
824 The \fIfstype\fR and \fIpath\fR operands must appear after the option, but
825 before the \fIinterval\fR or \fIcount\fR on the command line. For example,
826 "\fBfsstat\fR \fB-a\fR \fIfstype\fR \fIinterval\fR". Preference is given to
827 \fIfstype\fR so that if a user wishes to see the statistics for a directory
828 that has the same name as an \fIfstype\fR (for example, ufs), then the path
829 must be specified unambiguously (for example, ./ufs). Similarly, in order to
830 define a file with a numeric name (for example, "10") from an interval or count
831 operand, the name should be prefixed accordingly (for example, ./10).
832 .sp
833 .LP
834 When an interval is used, headers repeat after more than 12 lines of statistics
835 have been displayed and the set of lines to be displayed in the current
836 interval have completed.
837 .sp
838 .LP
839 Statistics are not displayed for all pseudo-filesystems. The output displayed
840 with the \fB-F\fR option shows which of the loaded filesystem types are
841 supported.
842 .sp
843 .LP
844 Unbundled file systems may not be recognized by \fBfsstat\fR.
845 .sp
846 .LP
847 The command-line options are classified as Unstable and could change. The
848 output is not considered to be an interface. The construction of higher level
849 software tools depend on either the command-line options or the output of
850 \fBfsstat\fR is not recommended.