xref: /xnu-10002.61.3/bsd/net/if_mib.h (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1 /*
2  * Copyright (c) 2000-2019 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 <net/if_var.h>
62 #include <sys/appleapiopts.h>
63 #include <sys/types.h>
64 
65 struct ifmibdata {
66 	char                            ifmd_name[IFNAMSIZ]; /* name of interface */
67 	unsigned int            ifmd_pcount;    /* number of promiscuous listeners */
68 	unsigned int            ifmd_flags;     /* interface flags */
69 	unsigned int            ifmd_snd_len;   /* instantaneous length of send queue */
70 	unsigned int            ifmd_snd_maxlen; /* maximum length of send queue */
71 	unsigned int            ifmd_snd_drops; /* number of drops in send queue */
72 	unsigned int            ifmd_filler[4]; /* for future expansion */
73 	struct if_data64        ifmd_data; /* generic information and statistics */
74 };
75 
76 #ifdef PRIVATE
77 struct ifmibdata_supplemental {
78 	struct if_traffic_class ifmd_traffic_class;
79 	struct if_data_extended ifmd_data_extended;
80 	struct if_packet_stats  ifmd_packet_stats;
81 	struct if_rxpoll_stats  ifmd_rxpoll_stats;
82 	struct if_netif_stats   ifmd_netif_stats;
83 };
84 #endif /* PRIVATE */
85 
86 /*
87  * sysctl MIB tags at the net.link.generic level
88  */
89 #define IFMIB_SYSTEM    1       /* non-interface-specific */
90 #define IFMIB_IFDATA    2       /* per-interface data table */
91 #define IFMIB_IFALLDATA 3       /* all interfaces data at once */
92 
93 /*
94  * MIB tags for the various net.link.generic.ifdata tables
95  */
96 #define IFDATA_GENERAL          1       /* generic stats for all kinds of ifaces */
97 #define IFDATA_LINKSPECIFIC     2       /* specific to the type of interface */
98 #define IFDATA_ADDRS            3       /* addresses assigned to interface */
99 #define IFDATA_MULTIADDRS       4       /* multicast addresses assigned to interface */
100 #ifdef PRIVATE
101 #define IFDATA_SUPPLEMENTAL     5       /* supplemental link specific stats */
102 #endif /* PRIVATE */
103 
104 /*
105  * MIB tags at the net.link.generic.system level
106  */
107 #define IFMIB_IFCOUNT   1       /* number of interfaces configured */
108 
109 /*
110  * MIB tags as the net.link level
111  * All of the other values are IFT_* names defined in if_types.h.
112  */
113 #define NETLINK_GENERIC 0       /* functions not specific to a type of iface */
114 
115 /*
116  * The reason why the IFDATA_LINKSPECIFIC stuff is not under the
117  * net.link.<iftype> branches is twofold:
118  *   1) It's easier to code this way, and doesn't require duplication.
119  *   2) The fourth level under net.link.<iftype> is <pf>; that is to say,
120  *	the net.link.<iftype> tree instruments the adaptation layers between
121  *	<iftype> and a particular protocol family (e.g., net.link.ether.inet
122  *	instruments ARP).  This does not really leave room for anything else
123  *	that needs to have a well-known number.
124  */
125 
126 /*
127  * Link-specific MIB structures for various link types.
128  */
129 
130 /* For IFT_ETHER, IFT_ISO88023, and IFT_STARLAN, as used by RFC 1650 */
131 struct ifs_iso_8802_3 {
132 	u_int32_t       dot3StatsAlignmentErrors;
133 	u_int32_t       dot3StatsFCSErrors;
134 	u_int32_t       dot3StatsSingleCollisionFrames;
135 	u_int32_t       dot3StatsMultipleCollisionFrames;
136 	u_int32_t       dot3StatsSQETestErrors;
137 	u_int32_t       dot3StatsDeferredTransmissions;
138 	u_int32_t       dot3StatsLateCollisions;
139 	u_int32_t       dot3StatsExcessiveCollisions;
140 	u_int32_t       dot3StatsInternalMacTransmitErrors;
141 	u_int32_t       dot3StatsCarrierSenseErrors;
142 	u_int32_t       dot3StatsFrameTooLongs;
143 	u_int32_t       dot3StatsInternalMacReceiveErrors;
144 	u_int32_t       dot3StatsEtherChipSet;
145 	/* Matt Thomas wants this one, not included in RFC 1650: */
146 	u_int32_t       dot3StatsMissedFrames;
147 
148 	u_int32_t       dot3StatsCollFrequencies[16]; /* NB: index origin */
149 
150 	u_int32_t       dot3Compliance;
151 #define DOT3COMPLIANCE_STATS    1
152 #define DOT3COMPLIANCE_COLLS    2
153 };
154 
155 /*
156  * Chipset identifiers are normally part of the vendor's enterprise MIB.
157  * However, we don't want to be trying to represent arbitrary-length
158  * OBJECT IDENTIFIERs here (ick!), and the right value is not necessarily
159  * obvious to the driver implementor.  So, we define our own identification
160  * mechanism here, and let the agent writer deal with the translation.
161  */
162 #define DOT3CHIPSET_VENDOR(x)   ((x) >> 16)
163 #define DOT3CHIPSET_PART(x)     ((x) & 0xffff)
164 #define DOT3CHIPSET(v, p)        (((v) << 16) + ((p) & 0xffff))
165 
166 /* Driver writers!  Add your vendors here! */
167 enum dot3Vendors {
168 	dot3VendorAMD = 1,
169 	dot3VendorIntel = 2,
170 	dot3VendorNational = 4,
171 	dot3VendorFujitsu = 5,
172 	dot3VendorDigital = 6,
173 	dot3VendorWesternDigital = 7
174 };
175 
176 /* Driver writers!  Add your chipsets here! */
177 enum {
178 	dot3ChipSetAMD7990 = 1,
179 	dot3ChipSetAMD79900 = 2,
180 	dot3ChipSetAMD79C940 = 3
181 };
182 
183 enum {
184 	dot3ChipSetIntel82586 = 1,
185 	dot3ChipSetIntel82596 = 2,
186 	dot3ChipSetIntel82557 = 3
187 };
188 
189 enum {
190 	dot3ChipSetNational8390 = 1,
191 	dot3ChipSetNationalSonic = 2
192 };
193 
194 enum {
195 	dot3ChipSetFujitsu86950 = 1
196 };
197 
198 enum {
199 	dot3ChipSetDigitalDC21040 = 1,
200 	dot3ChipSetDigitalDC21140 = 2,
201 	dot3ChipSetDigitalDC21041 = 3,
202 	dot3ChipSetDigitalDC21140A = 4,
203 	dot3ChipSetDigitalDC21142 = 5
204 };
205 
206 enum {
207 	dot3ChipSetWesternDigital83C690 = 1,
208 	dot3ChipSetWesternDigital83C790 = 2
209 };
210 /* END of Ethernet-link MIB stuff */
211 
212 /*
213  * Put other types of interface MIBs here, or in interface-specific
214  * header files if convenient ones already exist.
215  */
216 
217 /*
218  * Structure for interface family ID table
219  */
220 
221 struct if_family_id {
222 	u_int32_t               iffmid_len;
223 	u_int32_t               iffmid_id;
224 	char                    iffmid_str[1];  /* variable length string */
225 };
226 
227 
228 #endif /* _NET_IF_MIB_H */
229