bsd/net/if_mib.h

   1 /*
   2  * Copyright (c) 2000-2011 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright 1996 Massachusetts Institute of Technology
  30  *
  31  * Permission to use, copy, modify, and distribute this software and
  32  * its documentation for any purpose and without fee is hereby
  33  * granted, provided that both the above copyright notice and this
  34  * permission notice appear in all copies, that both the above
  35  * copyright notice and this permission notice appear in all
  36  * supporting documentation, and that the name of M.I.T. not be used
  37  * in advertising or publicity pertaining to distribution of the
  38  * software without specific, written prior permission.  M.I.T. makes
  39  * no representations about the suitability of this software for any
  40  * purpose.  It is provided "as is" without express or implied
  41  * warranty.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  44  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  45  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  46  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  47  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  50  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  51  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  52  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  53  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54  * SUCH DAMAGE.
  55  *
  56  * $FreeBSD: src/sys/net/if_mib.h,v 1.6 1999/08/28 00:48:19 peter Exp $
  57  */
  58
  59 #ifndef _NET_IF_MIB_H
  60 #define _NET_IF_MIB_H   1
  61 #include <sys/appleapiopts.h>
  62
  63 struct ifmibdata {
  64         char                            ifmd_name[IFNAMSIZ]; /* name of interface */
  65         unsigned int            ifmd_pcount;    /* number of promiscuous listeners */
  66         unsigned int            ifmd_flags;     /* interface flags */
  67         unsigned int            ifmd_snd_len;   /* instantaneous length of send queue */
  68         unsigned int            ifmd_snd_maxlen; /* maximum length of send queue */
  69         unsigned int            ifmd_snd_drops; /* number of drops in send queue */
  70         unsigned int            ifmd_filler[4]; /* for future expansion */
  71         struct if_data64        ifmd_data; /* generic information and statistics */
  72 };
  73
  74 #ifdef PRIVATE
  75 struct ifmibdata_supplemental {
  76         struct if_traffic_class ifmd_traffic_class;
  77         struct if_data_extended ifmd_data_extended;
  78         struct if_packet_stats  ifmd_packet_stats;
  79         struct if_rxpoll_stats  ifmd_rxpoll_stats;
  80 };
  81 #endif /* PRIVATE */
  82
  83 /*
  84  * sysctl MIB tags at the net.link.generic level
  85  */
  86 #define IFMIB_SYSTEM    1       /* non-interface-specific */
  87 #define IFMIB_IFDATA    2       /* per-interface data table */
  88 #define IFMIB_IFALLDATA 3       /* all interfaces data at once */
  89
  90 /*
  91  * MIB tags for the various net.link.generic.ifdata tables
  92  */
  93 #define IFDATA_GENERAL          1       /* generic stats for all kinds of ifaces */
  94 #define IFDATA_LINKSPECIFIC     2       /* specific to the type of interface */
  95 #define IFDATA_ADDRS            3       /* addresses assigned to interface */
  96 #define IFDATA_MULTIADDRS       4       /* multicast addresses assigned to interface */
  97 #ifdef PRIVATE
  98 #define IFDATA_SUPPLEMENTAL     5       /* supplemental link specific stats */
  99 #endif /* PRIVATE */
 100
 101 /*
 102  * MIB tags at the net.link.generic.system level
 103  */
 104 #define IFMIB_IFCOUNT   1       /* number of interfaces configured */
 105
 106 /*
 107  * MIB tags as the net.link level
 108  * All of the other values are IFT_* names defined in if_types.h.
 109  */
 110 #define NETLINK_GENERIC 0       /* functions not specific to a type of iface */
 111
 112 /*
 113  * The reason why the IFDATA_LINKSPECIFIC stuff is not under the
 114  * net.link.<iftype> branches is twofold:
 115  *   1) It's easier to code this way, and doesn't require duplication.
 116  *   2) The fourth level under net.link.<iftype> is <pf>; that is to say,
 117  *      the net.link.<iftype> tree instruments the adaptation layers between
 118  *      <iftype> and a particular protocol family (e.g., net.link.ether.inet
 119  *      instruments ARP).  This does not really leave room for anything else
 120  *      that needs to have a well-known number.
 121  */
 122
 123 /*
 124  * Link-specific MIB structures for various link types.
 125  */
 126
 127 /* For IFT_ETHER, IFT_ISO88023, and IFT_STARLAN, as used by RFC 1650 */
 128 struct ifs_iso_8802_3 {
 129         u_int32_t       dot3StatsAlignmentErrors;
 130         u_int32_t       dot3StatsFCSErrors;
 131         u_int32_t       dot3StatsSingleCollisionFrames;
 132         u_int32_t       dot3StatsMultipleCollisionFrames;
 133         u_int32_t       dot3StatsSQETestErrors;
 134         u_int32_t       dot3StatsDeferredTransmissions;
 135         u_int32_t       dot3StatsLateCollisions;
 136         u_int32_t       dot3StatsExcessiveCollisions;
 137         u_int32_t       dot3StatsInternalMacTransmitErrors;
 138         u_int32_t       dot3StatsCarrierSenseErrors;
 139         u_int32_t       dot3StatsFrameTooLongs;
 140         u_int32_t       dot3StatsInternalMacReceiveErrors;
 141         u_int32_t       dot3StatsEtherChipSet;
 142         /* Matt Thomas wants this one, not included in RFC 1650: */
 143         u_int32_t       dot3StatsMissedFrames;
 144
 145         u_int32_t       dot3StatsCollFrequencies[16]; /* NB: index origin */
 146
 147         u_int32_t       dot3Compliance;
 148 #define DOT3COMPLIANCE_STATS    1
 149 #define DOT3COMPLIANCE_COLLS    2
 150 };
 151
 152 /*
 153  * Chipset identifiers are normally part of the vendor's enterprise MIB.
 154  * However, we don't want to be trying to represent arbitrary-length
 155  * OBJECT IDENTIFIERs here (ick!), and the right value is not necessarily
 156  * obvious to the driver implementor.  So, we define our own identification
 157  * mechanism here, and let the agent writer deal with the translation.
 158  */
 159 #define DOT3CHIPSET_VENDOR(x)   ((x) >> 16)
 160 #define DOT3CHIPSET_PART(x)     ((x) & 0xffff)
 161 #define DOT3CHIPSET(v,p)        (((v) << 16) + ((p) & 0xffff))
 162
 163 /* Driver writers!  Add your vendors here! */
 164 enum dot3Vendors {
 165         dot3VendorAMD = 1,
 166         dot3VendorIntel = 2,
 167         dot3VendorNational = 4,
 168         dot3VendorFujitsu = 5,
 169         dot3VendorDigital = 6,
 170         dot3VendorWesternDigital = 7
 171 };
 172
 173 /* Driver writers!  Add your chipsets here! */
 174 enum {
 175         dot3ChipSetAMD7990 = 1,
 176         dot3ChipSetAMD79900 = 2,
 177         dot3ChipSetAMD79C940 = 3
 178 };
 179
 180 enum {
 181         dot3ChipSetIntel82586 = 1,
 182         dot3ChipSetIntel82596 = 2,
 183         dot3ChipSetIntel82557 = 3
 184 };
 185
 186 enum {
 187         dot3ChipSetNational8390 = 1,
 188         dot3ChipSetNationalSonic = 2
 189 };
 190
 191 enum {
 192         dot3ChipSetFujitsu86950 = 1
 193 };
 194
 195 enum {
 196         dot3ChipSetDigitalDC21040 = 1,
 197         dot3ChipSetDigitalDC21140 = 2,
 198         dot3ChipSetDigitalDC21041 = 3,
 199         dot3ChipSetDigitalDC21140A = 4,
 200         dot3ChipSetDigitalDC21142 = 5
 201 };
 202
 203 enum {
 204         dot3ChipSetWesternDigital83C690 = 1,
 205         dot3ChipSetWesternDigital83C790 = 2
 206 };
 207 /* END of Ethernet-link MIB stuff */
 208
 209 /*
 210  * Put other types of interface MIBs here, or in interface-specific
 211  * header files if convenient ones already exist.
 212  */
 213
 214 /*
 215  * Structure for interface family ID table
 216  */
 217
 218 struct if_family_id {
 219         u_int32_t               iffmid_len;
 220         u_int32_t               iffmid_id;
 221         char                    iffmid_str[1];  /* variable length string */
 222 };
 223
 224
 225 #endif /* _NET_IF_MIB_H */