6253 F_GETLK doesn't always return lock owner
[illumos-gate.git] / usr / src / man / man1m / dsstat.1m
blob16a8ba8ca93c1dad9af99e863a5a58fad5b5e958
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 DSSTAT 1M "Oct 2, 2007"
7 .SH NAME
8 dsstat \- report Sun StorageTek Availability Suite I/O statistics
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBdsstat\fR \fB-m\fR \fImode\fR [\fB-r\fR \fIreport-options\fR] [\fB-d\fR \fIdisplay-options\fR]
13  [\fB-s\fR \fIvolume-sets\fR] [\fB-f\fR | \fB-F\fR] [\fB-z\fR] [\fIinterval\fR [\fIcount\fR]]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fBdsstat\fR command collects and reports I/O statistics for the Sun
20 StorageTek Availability Suite products.
21 .SH OPTIONS
22 .sp
23 .LP
24 The \fBdsstat\fR supports the following options:
25 .sp
26 .ne 2
27 .na
28 \fB\fB-m\fR \fB\fImode\fR\fR\fR
29 .ad
30 .sp .6
31 .RS 4n
32 Specifies the mode(s) of operation. Valid modes are:
33 .sp
34 .ne 2
35 .na
36 \fB\fBcache\fR\fR
37 .ad
38 .sp .6
39 .RS 4n
40 Cache statistics
41 .RE
43 .sp
44 .ne 2
45 .na
46 \fB\fBii\fR\fR
47 .ad
48 .sp .6
49 .RS 4n
50 Point-in-Time Copy statistics
51 .RE
53 .sp
54 .ne 2
55 .na
56 \fB\fBsndr\fR\fR
57 .ad
58 .sp .6
59 .RS 4n
60 Remote Mirror statistics
61 .RE
63 To display statistics for multiple services simultaneously, use the \fB-m\fR
64 switch to specify each of the modes required. For example:
65 .sp
66 .in +2
67 .nf
68 % \fBdsstat -m ii -m sndr\fR
69 % \fBdsstat -m ii -m sndr -m cache\fR
70 .fi
71 .in -2
72 .sp
74 To determine which statistics are being reported from which service, use the
75 \fIrole\fR field, described below. When cache statistics are requested as one
76 of the multiple services, the \fBrkps\fR and \fBwkps\fR statistics is further
77 divided into \fBcrkps\fR, \fBdrkps\fR, \fBcwkps\fR, and \fBdwkps\fR. If no
78 \fB-m\fR switch is specified, then \fBdsstat\fR displays default statistics for
79 all of the valid modes as described above. See "Field Descriptions," below for
80 descriptions of these fields.
81 .RE
83 .sp
84 .ne 2
85 .na
86 \fB\fB-r\fR \fB\fIreport-options\fR\fR\fR
87 .ad
88 .sp .6
89 .RS 4n
90 Specifies the volume components to be displayed. Each item is represented by a
91 single character, and multiple items can be selected. The \fIreport-options\fR
92 vary based on the mode(s) specified above. This option is not used for
93 \fBcache\fR mode.
94 .sp
95 Valid \fIreport-options\fR for \fBii\fR mode are:
96 .sp
97 .ne 2
98 .na
99 \fB\fBm\fR\fR
101 .RS 13n
102 Master volume statistics.
103 .RS +4
105 .ie t \(bu
106 .el o
107 For the "report-options for ii mode": \fBm\fR, \fBs\fR, \fBb\fR, \fBo\fR
109 .RS +4
111 .ie t \(bu
112 .el o
113 For the "report-options for sndr mode": \fBb\fR, \fBn\fR
115 .RS +4
117 .ie t \(bu
118 .el o
119 For the "display-options for cache mode": \fBr\fR, \fBw\fR, \fBd\fR, \fBc\fR,
120 \fBs\fR, \fBf\fR
122 .RS +4
124 .ie t \(bu
125 .el o
126 For the "display-options for ii mode": \fBr\fR, \fBw\fR, \fBt\fR, \fBs\fR,
127 \fBp\fR, \fBf\fR
132 .ne 2
134 \fB\fBs\fR\fR
136 .RS 13n
137 Shadow volume statistics.
141 .ne 2
143 \fB\fBb\fR\fR
145 .RS 13n
146 Bitmap volume statistics.
150 .ne 2
152 \fB\fBo\fR\fR
154 .RS 13n
155 Overflow volume statistics, if attached.
158 Valid \fIreport-options\fR for \fBsndr\fR mode are:
160 .ne 2
162 \fB\fBb\fR\fR
164 .RS 13n
165 Bitmap volume statistics.
169 .ne 2
171 \fB\fBn\fR\fR
173 .RS 13n
174 Network volume statistics.
180 .ne 2
182 \fB\fB-d\fR \fIdisplay-options\fR\fR
184 .sp .6
185 .RS 4n
186 Specifies the statistics to be displayed. The types of statistics are
187 represented by a single character; multiple types can be specified.
189 For \fBcache\fR mode, the valid \fIdisplay-options\fR are:
191 .ne 2
193 \fB\fBr\fR\fR
195 .RS 13n
196 Detailed read statistics.
200 .ne 2
202 \fB\fBw\fR\fR
204 .RS 13n
205 Detailed write statistics.
209 .ne 2
211 \fB\fBs\fR\fR
213 .RS 13n
214 Summary statistics.
218 .ne 2
220 \fB\fBf\fR\fR
222 .RS 13n
223 Cache behavior flags.
226 The following \fIdisplay-options\fR are available only for cache mode, they
227 need to be combined with the mode options (\fB-m\fR)
229 .ne 2
231 \fB\fBd\fR\fR
233 .RS 13n
234 Destaged data statistics.
238 .ne 2
240 \fB\fBc\fR\fR
242 .RS 13n
243 Write cancellation statistics.
246 The default \fIdisplay-options\fR for \fBcache\fR are \fBsf\fR.
248 For \fBii\fR mode, the valid \fIdisplay-options\fR are:
250 .ne 2
252 \fB\fBr\fR\fR
254 .sp .6
255 .RS 4n
256 Detailed read statistics.
260 .ne 2
262 \fB\fBw\fR\fR
264 .sp .6
265 .RS 4n
266 Detailed write statistics.
270 .ne 2
272 \fB\fBt\fR\fR
274 .sp .6
275 .RS 4n
276 Timing statistics.
280 .ne 2
282 \fB\fBs\fR\fR
284 .sp .6
285 .RS 4n
286 Summary statistics.
290 .ne 2
292 \fB\fBp\fR\fR
294 .sp .6
295 .RS 4n
296 Percentage of volume requiring sync.
300 .ne 2
302 \fB\fBf\fR\fR
304 .sp .6
305 .RS 4n
306 Volume type/status flags.
309 The default \fIdisplay-options\fR for \fBii\fR are \fBspf\fR. For \fBsndr\fR
310 mode, the valid \fIdisplay-options\fR are:
312 .ne 2
314 \fB\fBr\fR\fR
316 .RS 13n
317 Detailed read statistics.
321 .ne 2
323 \fB\fBw\fR\fR
325 .RS 13n
326 Detailed write statistics.
330 .ne 2
332 \fB\fBt\fR\fR
334 .RS 13n
335 Timing statistics.
339 .ne 2
341 \fB\fBs\fR\fR
343 .RS 13n
344 Summary statistics.
348 .ne 2
350 \fB\fBp\fR\fR
352 .RS 13n
353 Percentage of volume requiring sync.
357 .ne 2
359 \fB\fBf\fR\fR
361 .RS 13n
362 Volume type/status flags.
366 .ne 2
368 \fB\fBq\fR\fR
370 .RS 13n
371 Asynchronous queue statistics.
374 The following \fIdisplay-option\fR is only available for \fBsndr\fR mode, and
375 needs to be combined with the mode options (\fB-m\fR).
377 .ne 2
379 \fB\fBq\fR\fR
381 .RS 13n
382 Asynchronous queue statistics.
385 The default \fIdisplay-options\fR for \fBsndr\fR are \fBspf\fR.
387 Specifying the summary \fIdisplay-option\fR causes \fBr\fR \fBw\fR \fBt\fR
388 \fIdisplay-options\fR to be ignored.
392 .ne 2
394 \fB\fB-s\fR \fB\fIvolume-sets\fR\fR\fR
396 .RS 20n
397 Filters the output to include only the specified \fIvolume-sets\fR, where
398 \fIvolume-sets\fR is a comma-delimited list of volume names. When displaying
399 Remote Mirror statistics, the name specified is compared to the Remote Mirror
400 primary volume to determine if they match. Additionally, an Remote Mirror
401 volume should be specified as \fI<host>\fR:\fI<volume>\fR where \fI<host>\fR is
402 the primary or secondary host and \fI<volume>\fR is the volume name by which
403 that host recognizes the volume set. When specifying multiple Remote Mirror
404 volumes sets, be aware that each volume set specified is evaluated
405 individually, using the rules above. When displaying Point-in-Time Copy
406 statistics, the volume name specified is compared to the Point-in-Time Copy
407 shadow volume to determine if they match.
411 .ne 2
413 \fB\fB-f\fR\fR
415 .RS 20n
416 Output field headers at every reporting cycle.
420 .ne 2
422 \fB\fB-F\fR\fR
424 .RS 20n
425 Output field headers once, when reporting begins.
429 .ne 2
431 \fB\fB-z\fR\fR
433 .RS 20n
434 Suppress report lines that have zero values or no activity.
437 .SH OPERANDS
440 The \fBdsstat\fR command line supports the following operands:
442 .ne 2
444 \fB\fIinterval\fR\fR
446 .sp .6
447 .RS 4n
448 Specifies the \fIinterval\fR for each report, in seconds. If no \fIinterval\fR
449 is specified, a single report with a one second \fIinterval\fR is output.
451 Due to the varying number of entries in a given set and the varying number of
452 sets, header information might appear in the middle of a set being reported. To
453 avoid this, use the \fB-f\fR or \fB-F\fR options to display the header
454 information at the desired time.
458 .ne 2
460 \fB\fIcount\fR\fR
462 .sp .6
463 .RS 4n
464 Specifies the number of reports to generate. If no \fIcount\fR is specified,
465 output continues until interrupted.
468 .SS "Field Descriptions"
471 Unless otherwise specified, all fields are per-second averages based on the
472 data collected during the specified \fIinterval\fR.
474 .ne 2
476 \fB\fBname\fR\fR
478 .RS 13n
479 Name of the entity being reported
483 .ne 2
485 \fB\fBt\fR\fR
487 .RS 13n
488 Volume type
492 .ne 2
494 \fB\fBs\fR\fR
496 .RS 13n
497 Volume status
501 .ne 2
503 \fB\fBr\fR\fR
505 .RS 13n
506 Cache read behavior
510 .ne 2
512 \fB\fBw\fR\fR
514 .RS 13n
515 Cache write behavior
519 .ne 2
521 \fB\fBpct\fR\fR
523 .RS 13n
524 Percentage of volume requiring sync
528 .ne 2
530 \fB\fBrole\fR\fR
532 .RS 13n
533 Role of the item being reported
537 .ne 2
539 \fB\fBtps\fR\fR
541 .RS 13n
542 Total number of reads + writes
546 .ne 2
548 \fB\fBrtps\fR\fR
550 .RS 13n
551 Number of reads
555 .ne 2
557 \fB\fBwtps\fR\fR
559 .RS 13n
560 Number of writes
564 .ne 2
566 \fB\fBkps\fR\fR
568 .RS 13n
569 Total kilobytes read + written
573 .ne 2
575 \fB\fBrkps\fR\fR
577 .RS 13n
578 Kilobytes read
582 .ne 2
584 \fB\fBwkps\fR\fR
586 .RS 13n
587 Kilobytes written
591 .ne 2
593 \fB\fBcrkps\fR\fR
595 .RS 13n
596 Kilobytes read from cache
600 .ne 2
602 \fB\fBdrkps\fR\fR
604 .RS 13n
605 Kilobytes read from disk
609 .ne 2
611 \fB\fBcwkps\fR\fR
613 .RS 13n
614 Kilobytes written to cache
618 .ne 2
620 \fB\fBdwkps\fR\fR
622 .RS 13n
623 Kilobytes written to disk
627 .ne 2
629 \fB\fBckps\fR\fR
631 .RS 13n
632 Kilobytes transferred to or from cache
636 .ne 2
638 \fB\fBdkps\fR\fR
640 .RS 13n
641 Kilobytes transferred to or from disk
645 .ne 2
647 \fB\fBsvt\fR\fR
649 .RS 13n
650 Service time per operation
654 .ne 2
656 \fB\fBhit\fR\fR
658 .RS 13n
659 Read hits during \fIinterval\fR
663 .ne 2
665 \fB\fBds/s\fR\fR
667 .RS 13n
668 Kilobytes destaged from cache
672 .ne 2
674 \fB\fBcn/s\fR\fR
676 .RS 13n
677 Number of write cancellations
681 .ne 2
683 \fB\fBq\fR\fR
685 .RS 13n
686 Type of asynchronous queuing being used
690 .ne 2
692 \fB\fBqi\fR\fR
694 .RS 13n
695 Number of items currently queued
699 .ne 2
701 \fB\fBqk\fR\fR
703 .RS 13n
704 Kilobytes currently queued
708 .ne 2
710 \fB\fBqhwi\fR\fR
712 .RS 13n
713 High water mark of queued items
717 .ne 2
719 \fB\fBqhwk\fR\fR
721 .RS 13n
722 High water mark of queued kilobytes
727 The \fBname\fR field displays only the last 16 characters of the name.
730 Valid cache behaviors for \fBcache\fR are:
732 .ne 2
734 \fB\fBC\fR\fR
736 .RS 13n
737 Cache reads/writes
741 .ne 2
743 \fB\fBD\fR\fR
745 .RS 13n
746 Disk reads/writes
751 Valid volume types for \fBii\fR are:
753 .ne 2
755 \fB\fBI\fR\fR
757 .RS 13n
758 Independent shadow volume
762 .ne 2
764 \fB\fBD\fR\fR
766 .RS 13n
767 Dependent shadow volume
772 Valid volume status for \fBii\fR is:
774 .ne 2
776 \fB\fBC\fR\fR
778 .RS 13n
779 Copy in progress
783 .ne 2
785 \fB\fB-\fR\fR
787 .RS 13n
788 No copy in progress
793 Valid volume types for \fBsndr\fR are:
795 .ne 2
797 \fB\fBP\fR\fR
799 .RS 13n
800 This is the primary host of this volume set
804 .ne 2
806 \fB\fBS\fR\fR
808 .RS 13n
809 This is the secondary host of this volume set
814 Valid volume status for \fBsndr\fR is:
816 .ne 2
818 \fB\fBL\fR\fR
820 .RS 13n
821 Changes to this volume are being logged
825 .ne 2
827 \fB\fBQ\fR\fR
829 .RS 13n
830 Volume are in queuing mode
834 .ne 2
836 \fB\fBR\fR\fR
838 .RS 13n
839 Replicating changes to secondary
843 .ne 2
845 \fB\fBSY\fR\fR
847 .RS 13n
848 Synchronization in progress. Sending data.
852 .ne 2
854 \fB\fBRS\fR\fR
856 .RS 13n
857 Reverse synchronization in progress. Receiving data.
861 .ne 2
863 \fB\fBSN\fR\fR
865 .RS 13n
866 Synchronization needed
870 .ne 2
872 \fB\fBRN\fR\fR
874 .RS 13n
875 Reverse synchronization needed
879 .ne 2
881 \fB\fBVF\fR\fR
883 .RS 13n
884 Volume failed
888 .ne 2
890 \fB\fBBF\fR\fR
892 .RS 13n
893 Bitmap failed
897 .ne 2
899 \fB\fBQF\fR\fR
901 .RS 13n
902 Queue failed
907 Valid queue types for \fBsndr\fR are:
909 .ne 2
911 \fB\fBD\fR\fR
913 .RS 13n
914 Disk-based queuing enabled
918 .ne 2
920 \fB\fBM\fR\fR
922 .RS 13n
923 Memory-based queuing enabled
928 Volume roles for \fBsndr\fR are:
930 .ne 2
932 \fB\fBnet\fR\fR
934 .RS 13n
935 Network volume statistics
939 .ne 2
941 \fB\fBbmp\fR\fR
943 .RS 13n
944 Bitmap volume statistics
949 Volume roles for \fBii\fR are:
951 .ne 2
953 \fB\fBmst\fR\fR
955 .RS 13n
956 Master volume statistics
960 .ne 2
962 \fB\fBshd\fR\fR
964 .RS 13n
965 Shadow volume statistics
969 .ne 2
971 \fB\fBbmp\fR\fR
973 .RS 13n
974 Bitmap volume statistics
978 .ne 2
980 \fB\fBovr\fR\fR
982 .RS 13n
983 Overflow volume statistics
986 .SH EXAMPLES
988 \fBExample 1 \fRReport Cache Statistics
991 The following example shows the display of Report Cache statistics, with
992 detailed breakdowns of read and writes to cache/disk. Reports are generated at
993 five second intervals. Reporting is limited to the set
994 \fB/dev/rdsk/c1t1d0s0\fR.
997 .in +2
999  # dsstat -m cache -d rw -s /dev/rdsk/c1t1d0s0 5
1000 - read -             - write -
1001 name                ckps   dkps    hit   ckps   dkps    hit
1002 dev/rdsk/c1t1d0s0      0      0   0.00      0      0   0.00
1003 dev/rdsk/c1t1d0s0      3   2396   0.13    983    763 100.00
1004 dev/rdsk/c1t1d0s0   2399    799  75.00   2815   2686 100.00
1005 dev/rdsk/c1t1d0s0   3200    800  80.00   2755   2908 100.00
1006 dev/rdsk/c1t1d0s0   3999    799  83.33   2809   2868 100.00
1007 dev/rdsk/c1t1d0s0   4800    800  85.71   2867   2931 100.00
1009 .in -2
1012 \fBExample 2 \fRReport Master, Shadow and Bitmap Statistics
1015 Report master, shadow and bitmap statistics for Point-in-Time Copy, using
1016 default output. Generate reports at two second intervals.
1019 .in +2
1021 # dsstat -m ii -r msb 2
1022 name               t  s    pct role    kps   tps  svt
1023 dev/rdsk/c0t1d0s5  I  C  96.15  mst  19921    38   22
1024 dev/rdsk/c0t1d0s6               shd   9960    19   20
1025 dev/rdsk/c0t1d0s7               bmp     39    77    2
1026 dev/rdsk/c0t1d0s5  I  C  94.24  mst  19623    38   22
1027 dev/rdsk/c0t1d0s6               shd   9939    19   20
1028 dev/rdsk/c0t1d0s7               bmp     39    77    2
1029 dev/rdsk/c0t1d0s5  I  C  92.34  mst  19969    39   22
1030 dev/rdsk/c0t1d0s6               shd   9984    19   20
1031 dev/rdsk/c0t1d0s7               bmp     39    78    2
1033 .in -2
1036 \fBExample 3 \fRReport Network Statistics for Remote Mirror
1039 Report network statistics for Remote Mirror, using detailed read, write
1040 statistics. Report includes volume type/status flags and percentages. Generate
1041 reports at two second intervals. Limit reporting to the set
1042 \fB/dev/rdsk/c0t1d0s0\fR.
1045 .in +2
1047 # dsstat -m sndr -r n -d rwpf -s /dev/rdsk/c0t1d0s0 2
1048 name               t  s    pct role   rkps  rtps   wkps  wtps
1049 dev/rdsk/c0t1d0s0  P  L 100.00  sec      0     0      0     0
1050 dev/rdsk/c0t1d0s0  P SY  99.90  sec      0     0    288     9
1051 dev/rdsk/c0t1d0s0  P SY  97.90  sec      0     0   5296   165
1052 dev/rdsk/c0t1d0s0  P SY  95.81  sec      0     0   5184   161
1053 dev/rdsk/c0t1d0s0  P SY  93.81  sec      0     0   5280   164
1054 dev/rdsk/c0t1d0s0  P SY  91.71  sec      0     0   5198   162
1056 .in -2
1058 .SH EXIT STATUS
1061 The following exit values are returned:
1063 .ne 2
1065 \fB\fB0\fR\fR
1067 .RS 13n
1068 Successful completion.
1072 .ne 2
1074 \fB\fB1\fR\fR
1076 .RS 13n
1077 Successful completion, no statistics to report.
1081 .ne 2
1083 \fB\fB2\fR\fR
1085 .RS 13n
1086 An invalid argument has been encountered.
1090 .ne 2
1092 \fB\fB3\fR\fR
1094 .RS 13n
1095 No memory is available to create \fBkstat\fR statistics.
1099 .ne 2
1101 \fB\fB4\fR\fR
1103 .RS 13n
1104 An unknown error has occurred.
1107 .SH ATTRIBUTES
1110 See \fBattributes\fR(5) for descriptions of the following attributes:
1115 box;
1116 c | c
1117 l | l .
1118 ATTRIBUTE TYPE  ATTRIBUTE VALUE
1120 Interface Stability     Evolving
1123 .SH SEE ALSO
1126 \fBdscfg\fR(1M), \fBsvadm\fR(1M), \fBds.log\fR(4), \fBrdc.cf\fR(4),
1127 \fBattributes\fR(5)