usr/src/man/man1m/syncstat.1m

   1 '\" te
   2 .\" Copyright (c) 1993, Sun Microsystems, Inc.
   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 SYNCSTAT 1M "Mar 9, 1993"
   7 .SH NAME
   8 syncstat \- report driver statistics from a synchronous serial link
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/syncstat\fR [\fB-c\fR] \fIdevice\fR [\fIinterval\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBsyncstat\fR command reports the event statistics maintained by a
  19 synchronous serial device driver. The report may be a single snapshot of the
  20 accumulated totals, or a series of samples showing incremental changes. Prior
  21 to these it prints the device name being used to query a particular device
  22 driver, along with a number indicating the channel number (ppa) under control
  23 of that driver.
  24 .sp
  25 .LP
  26 Event statistics are maintained by a driver for each physical channel that it
  27 supports. They are initialized to zero at the time the driver module is loaded
  28 into the system, which may be either at boot time or when one of the driver's
  29 entry points is first called.
  30 .sp
  31 .LP
  32 The  \fIdevice\fR argument is the name of the serial device as it appears in
  33 the \fB/dev\fR directory.  For example,  \fBzsh0\fR specifies the first
  34 on-board serial device.
  35 .sp
  36 .LP
  37 The following is a breakdown of  \fBsyncstat\fR output:
  38 .sp
  39
  40 .sp
  41 .TS
  42 l l
  43 l l .
  44 \fBspeed\fR     T{
  45 The line speed the device has been set to operate at. It is the user's responsibility to make this value correspond to the modem clocking speed when clocking is provided by the modem.
  46 T}
  47 \fBipkts\fR     The total number of input packets.
  48 \fBopkts\fR     The total number of output packets.
  49 \fBundrun\fR    T{
  50 The number of transmitter underrun errors.
  51 T}
  52 \fBovrrun\fR    The number of receiver overrun errors.
  53 \fBabort\fR     The number of aborted received frames.
  54 \fBcrc\fR       T{
  55 The number of received frames with CRC errors.
  56 T}
  57 \fBisize\fR     T{
  58 The average size (in bytes) of input packets.
  59 T}
  60 \fBosize\fR     T{
  61 The average size (in bytes) of output packets.
  62 T}
  63 .TE
  64
  65 .SH OPTIONS
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-c\fR\fR
  70 .ad
  71 .RS 12n
  72 Clear the accumulated statistics for the device specified. This may be useful
  73 when it is not desirable to unload a particular driver, or when the driver is
  74 not capable of being unloaded.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fIinterval\fR\fR
  81 .ad
  82 .RS 12n
  83 \fBsyncstat\fR samples the statistics every  \fIinterval\fR seconds and reports
  84 incremental changes. The output reports line utilization for input and output
  85 in place of average packet sizes. These are the relationships between bytes
  86 transferred and the baud rate, expressed as percentages. The loop repeats
  87 indefinitely, with a column heading printed every twenty lines for convenience.
  88 .RE
  89
  90 .SH EXAMPLES
  91 .LP
  92 \fBExample 1 \fRSample output from the \fBsyncstat\fR command:
  93 .sp
  94 .in +2
  95 .nf
  96 example# \fBsyncstat zsh0\fR
  97
  98
  99 speed ipkts opkts undrun ovrrun abort crc isize osize
 100 9600  15716 17121   0      0      1    3   98    89
 101 .fi
 102 .in -2
 103 .sp
 104
 105 .sp
 106 .in +2
 107 .nf
 108 example# \fBsyncstat \fR\fB-c\fR\fB zsh0\fR
 109
 110 speed ipkts opkts undrun ovrrun abort crc isize osize
 111 9600   0     0     0      0      0     0    0     0
 112 .fi
 113 .in -2
 114 .sp
 115
 116 .sp
 117 .LP
 118 In the following sample output a new line of output is generated every five
 119 seconds:
 120
 121 .sp
 122 .in +2
 123 .nf
 124 example# \fBsyncstat zsh0 5\fR
 125
 126 ipkts opkts undrun ovrrun abort crc iutil outil
 127 12    10      0     0      0     0   5%    4%
 128 22    60      0     0      0     0   3%    90%
 129 36    14      0     0      0     1   51%   2%
 130 .fi
 131 .in -2
 132 .sp
 133
 134 .SH SEE ALSO
 135 .sp
 136 .LP
 137 \fBsyncinit\fR(1M), \fBsyncloop\fR(1M), \fBattributes\fR(5), \fBzsh\fR(7D)
 138 .SH DIAGNOSTICS
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBbad interval: \fR\fIarg\fR\fR
 143 .ad
 144 .sp .6
 145 .RS 4n
 146 The argument  \fIarg\fR is expected to be an interval and could not be
 147 understood.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fIdevice\fR\fB missing minor device number\fR\fR
 154 .ad
 155 .sp .6
 156 .RS 4n
 157 The name  \fIdevice\fR does not end in a decimal number that can be used as a
 158 minor device number.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBbaud rate not set\fR\fR
 165 .ad
 166 .sp .6
 167 .RS 4n
 168 The  \fIinterval\fR option is being used and the baud rate on the device is
 169 zero. This would cause a divide-by-zero error when computing the line
 170 utilization statistics.
 171 .RE
 172
 173 .SH WARNINGS
 174 .sp
 175 .LP
 176 Underrun, overrun, frame-abort, and CRC errors have a variety of causes.
 177 Communication protocols are typically able to handle such errors and initiate
 178 recovery of the transmission in which the error occurred. Small numbers of such
 179 errors are not a significant problem for most protocols. However, because the
 180 overhead involved in recovering from a link error can be much greater than that
 181 of normal operation, high error rates can greatly degrade overall link
 182 throughput. High error rates are often caused by problems in the link hardware,
 183 such as cables, connectors, interface electronics or telephone lines. They may
 184 also be related to excessive load on the link or the supporting system.
 185 .sp
 186 .LP
 187 The percentages for input and output line utilization reported when using the
 188 \fIinterval\fR option may occasionally be reported as slightly greater than
 189 100% because of inexact sampling times and differences in the accuracy between
 190 the system clock and the modem clock. If the percentage of use greatly exceeds
 191 100%, or never exceeds 50%, then the baud rate set for the device probably does
 192 not reflect the speed of the modem.