share/man/man9s/gld_stats.9s

   1 '\" te
   2 .\" Copyright (c) 2004, 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 GLD_STATS 9S "Jun 7, 2004"
   7 .SH NAME
   8 gld_stats \- Generic LAN Driver statistics data structure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/gld.h>
  13 .fi
  14
  15 .SH INTERFACE LEVEL
  16 .sp
  17 .LP
  18 Solaris architecture specific (Solaris DDI).
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The Generic LAN Driver (GLD) statistics (\fBgld_stats\fR) structure is used to
  23 communicate statistics and state information from a GLD-based driver to GLD
  24 when returning from a driver's \fBgldm_get_stats()\fR routine as discussed in
  25 \fBgld\fR(9E) and \fBgld\fR(7D). The members of this structure, filled in by
  26 the GLD-based driver, are used when GLD reports the statistics. In the tables
  27 below, the name of the statistics variable reported by GLD is noted in the
  28 comments. See \fBgld\fR(7D) for a more detailed description of the meaning of
  29 each statistic.
  30 .sp
  31 .LP
  32 Drivers can make no assumptions about the length of this structure, which might
  33 be different in different releases of Solaris and/or GLD. Structure members
  34 private to GLD, not documented here, should not be set or read by the device
  35 specific driver.
  36 .SH STRUCTURE MEMBERS
  37 .sp
  38 .LP
  39 The following structure members are defined for all media types:
  40 .sp
  41 .in +2
  42 .nf
  43 uint64_t   glds_speed;               /* ifspeed */
  44 uint32_t   glds_media;               /* media */
  45 uint32_t   glds_intr;                /* intr */
  46 uint32_t   glds_norcvbuf;            /* norcvbuf */
  47 uint32_t   glds_errrcv;              /* ierrors */
  48 uint32_t   glds_errxmt;              /* oerrors */
  49 uint32_t   glds_missed;              /* missed */
  50 uint32_t   glds_underflow;           /* uflo */
  51 uint32_t   glds_overflow;            /* oflo */
  52 .fi
  53 .in -2
  54 .sp
  55
  56 .sp
  57 .LP
  58 The following structure members are defined for media type \fBDL_ETHER\fR:
  59 .sp
  60 .in +2
  61 .nf
  62 uint32_t   glds_frame;                   /* align_errors */
  63 uint32_t   glds_crc;                     /* fcs_errors */
  64 uint32_t   glds_duplex;                  /* duplex */
  65 uint32_t   glds_nocarrier;               /* carrier_errors */
  66 uint32_t   glds_collisions;              /* collisions */
  67 uint32_t   glds_excoll;                  /* ex_collisions */
  68 uint32_t   glds_xmtlatecoll;             /* tx_late_collisions */
  69 uint32_t   glds_defer;                   /* defer_xmts */
  70 uint32_t   glds_dot3_first_coll;         /* first_collisions */
  71 uint32_t   glds_dot3_multi_coll;         /* multi_collisions */
  72 uint32_t   glds_dot3_sqe_error;          /* sqe_errors */
  73 uint32_t   glds_dot3_mac_xmt_error;      /* macxmt_errors */
  74 uint32_t   glds_dot3_mac_rcv_error;      /* macrcv_errors */
  75 uint32_t   glds_dot3_frame_too_long;     /* toolong_errors */
  76 uint32_t   glds_short;                   /* runt_errors */
  77 .fi
  78 .in -2
  79 .sp
  80
  81 .sp
  82 .LP
  83 The following structure members are defined for media type \fBDL_TPR\fR:
  84 .sp
  85 .in +2
  86 .nf
  87 uint32_t   glds_dot5_line_error          /* line_errors */
  88 uint32_t   glds_dot5_burst_error         /* burst_errors */
  89 uint32_t   glds_dot5_signal_loss         /* signal_losses */
  90 uint32_t   glds_dot5_ace_error           /* ace_errors */
  91 uint32_t   glds_dot5_internal_error      /* internal_errors */
  92 uint32_t   glds_dot5_lost_frame_error    /* lost_frame_errors */
  93 uint32_t   glds_dot5_frame_copied_error  /* frame_copied_errors */
  94 uint32_t   glds_dot5_token_error         /* token_errors */
  95 uint32_t   glds_dot5_freq_error          /* freq_errors */
  96 .fi
  97 .in -2
  98 .sp
  99
 100 .LP
 101 Note -
 102 .sp
 103 .RS 2
 104 Support for the DL_TPR media type is obsolete and may be removed in a future
 105 release of Solaris.
 106 .RE
 107 .sp
 108 .LP
 109 The following structure members are defined for media type \fBDL_FDDI\fR:
 110 .sp
 111 .in +2
 112 .nf
 113 uint32_t   glds_fddi_mac_error;          /* mac_errors */
 114 uint32_t   glds_fddi_mac_lost;           /* mac_lost_errors */
 115 uint32_t   glds_fddi_mac_token;          /* mac_tokens */
 116 uint32_t   glds_fddi_mac_tvx_expired;    /* mac_tvx_expired */
 117 uint32_t   glds_fddi_mac_late;           /* mac_late */
 118 uint32_t   glds_fddi_mac_ring_op;        /* mac_ring_ops */
 119 .fi
 120 .in -2
 121 .sp
 122
 123 .LP
 124 Note -
 125 .sp
 126 .RS 2
 127 Support for the DL_FDDI media type is obsolete and may be removed in a future
 128 release of Solaris.
 129 .RE
 130 .sp
 131 .LP
 132 Most of the above statistics variables are counters denoting the number of
 133 times the particular event was observed. Exceptions are:
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBglds_speed\fR \fR
 138 .ad
 139 .RS 16n
 140 An estimate of the interface's current bandwidth in bits per second. For
 141 interfaces that do not vary in bandwidth or for those where no accurate
 142 estimation can be made, this object should contain the nominal bandwidth.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBglds_media\fR \fR
 149 .ad
 150 .RS 16n
 151 The type of media (wiring) or connector used by the hardware. Currently
 152 supported media names include \fBGLDM_AUI\fR, \fBGLDM_BNC\fR, \fBGLDM_TP\fR,
 153 \fBGLDM_10BT\fR, \fBGLDM_100BT\fR, \fBGLDM_100BTX\fR, \fBGLDM_100BT4\fR,
 154 \fBGLDM_RING4\fR, \fBGLDM_RING16\fR, \fBGLDM_FIBER\fR, and \fBGLDM_PHYMII\fR.
 155 \fBGLDM_UNKNOWN\fR can also be specified.
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fBglds_duplex\fR \fR
 162 .ad
 163 .RS 16n
 164 Current duplex state of the interface. Supported values are
 165 \fBGLD_DUPLEX_HALF\fR and \fBGLD_DUPLEX_FULL\fR. \fBGLD_DUPLEX_UNKNOWN\fR can
 166 also be specified.
 167 .RE
 168
 169 .SH SEE ALSO
 170 .sp
 171 .LP
 172 \fBgld\fR(7D), \fBgld\fR(9F), \fBgld\fR(9E), \fBgld_mac_info\fR(9S)
 173 .sp
 174 .LP
 175 \fIWriting Device Drivers\fR