1 /*
2 * Copyright (c) 2000-2017 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 * Fundamental constants relating to ethernet.
30 *
31 */
32
33 #ifndef _NET_ETHERNET_H_
34 #define _NET_ETHERNET_H_
35 #ifndef DRIVERKIT
36 #include <sys/appleapiopts.h>
37 #include <sys/types.h> /* u_ types */
38 #else
39 #include <sys/_types.h>
40 #include <sys/_types/_u_char.h>
41 #include <sys/_types/_u_short.h>
42 #endif /* DRIVERKIT */
43
44 /*
45 * The number of bytes in an ethernet (MAC) address.
46 */
47 #define ETHER_ADDR_LEN 6
48
49 /*
50 * The number of bytes in the type field.
51 */
52 #define ETHER_TYPE_LEN 2
53
54 /*
55 * The number of bytes in the trailing CRC field.
56 */
57 #define ETHER_CRC_LEN 4
58
59 /*
60 * The length of the combined header.
61 */
62 #define ETHER_HDR_LEN (ETHER_ADDR_LEN*2+ETHER_TYPE_LEN)
63
64 /*
65 * The minimum packet length.
66 */
67 #define ETHER_MIN_LEN 64
68
69 /*
70 * The maximum packet length.
71 */
72 #define ETHER_MAX_LEN 1518
73
74 /*
75 * Mbuf adjust factor to force 32-bit alignment of IP header.
76 * Drivers should do m_adj(m, ETHER_ALIGN) when setting up a
77 * receive so the upper layers get the IP header properly aligned
78 * past the 14-byte Ethernet header.
79 */
80 #define ETHER_ALIGN 2 /* driver adjust for IP hdr alignment */
81
82 /*
83 * A macro to validate a length with
84 */
85 #define ETHER_IS_VALID_LEN(foo) \
86 ((foo) >= ETHER_MIN_LEN && (foo) <= ETHER_MAX_LEN)
87
88 /*
89 * Structure of a 10Mb/s Ethernet header.
90 */
91 typedef struct ether_header {
92 u_char ether_dhost[ETHER_ADDR_LEN];
93 u_char ether_shost[ETHER_ADDR_LEN];
94 u_short ether_type;
95 } ether_header_t;
96
97 /*
98 * Structure of a 48-bit Ethernet address.
99 */
100 typedef struct ether_addr {
101 u_char octet[ETHER_ADDR_LEN];
102 } ether_addr_t;
103
104 #define ether_addr_octet octet
105
106 #define ETHERTYPE_PUP 0x0200 /* PUP protocol */
107 #define ETHERTYPE_IP 0x0800 /* IP protocol */
108 #define ETHERTYPE_ARP 0x0806 /* Addr. resolution protocol */
109 #define ETHERTYPE_REVARP 0x8035 /* reverse Addr. resolution protocol */
110 #define ETHERTYPE_VLAN 0x8100 /* IEEE 802.1Q VLAN tagging */
111 #define ETHERTYPE_IPV6 0x86dd /* IPv6 */
112 #define ETHERTYPE_PAE 0x888e /* EAPOL PAE/802.1x */
113 #define ETHERTYPE_WAI 0x88b4 /* WAI Authentication Protocol */
114 #define ETHERTYPE_RSN_PREAUTH 0x88c7 /* 802.11i / RSN Pre-Authentication */
115 #define ETHERTYPE_PTP 0x88f7 /* IEEE 1588 Precision Time Protocol */
116 #define ETHERTYPE_LOOPBACK 0x9000 /* used to test interfaces */
117 /* XXX - add more useful types here */
118
119 /*
120 * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
121 * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
122 * by an ETHER type (as given above) and then the (variable-length) header.
123 */
124 #define ETHERTYPE_TRAIL 0x1000 /* Trailer packet */
125 #define ETHERTYPE_NTRAILER 16
126
127 #define ETHERMTU (ETHER_MAX_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
128 #define ETHERMIN (ETHER_MIN_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
129
130 #ifndef DRIVERKIT
131 #ifdef KERNEL_PRIVATE
132 /*
133 * The following are used by ethernet interfaces.
134 */
135
136 struct ether_addr *ether_aton(const char *);
137
138 #ifdef BSD_KERNEL_PRIVATE
139 extern u_char etherbroadcastaddr[ETHER_ADDR_LEN];
140
141
142 // TODO: This should really be `__sized_by(ETHER_ADDR_LEN)` rather than
143 // `__unsafe_indexable` on the parameters but it is being omitted until the perf
144 // impact of adding bounds checks is analyzed (rdar://117166943)
145 static __inline__ int
_ether_cmp(const void * __unsafe_indexable a,const void * __unsafe_indexable b)146 _ether_cmp(const void *__unsafe_indexable a, const void *__unsafe_indexable b)
147 {
148 // Given that `ETHER_ADDR_LEN` is a constant one might expect all
149 // bounds checks to be removed in optimized code. Unfortunately a bug
150 // means not all bounds checks are removed (rdar://117279245).
151 const u_int16_t * __unsafe_indexable a_s = __unsafe_forge_bidi_indexable(
152 const u_int16_t *, a, ETHER_ADDR_LEN);
153 const u_int16_t * __unsafe_indexable b_s = __unsafe_forge_bidi_indexable(
154 const u_int16_t *, b, ETHER_ADDR_LEN);
155
156 if (a_s[0] != b_s[0]
157 || a_s[1] != b_s[1]
158 || a_s[2] != b_s[2]) {
159 return 1;
160 }
161 return 0;
162 }
163
164 #endif /* BSD_KERNEL_PRIVATE */
165
166 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */
167
168 #endif /* KERNEL_PRIVATE */
169
170 #ifndef KERNEL
171 #include <sys/cdefs.h>
172
173 /*
174 * Ethernet address conversion/parsing routines.
175 */
176 __BEGIN_DECLS
177
178 int ether_hostton(const char *, struct ether_addr *);
179 int ether_line(const char *, struct ether_addr *, char *);
180 char *ether_ntoa(const struct ether_addr *);
181 struct ether_addr *ether_aton(const char *);
182 int ether_ntohost(char *, const struct ether_addr *);
183 __END_DECLS
184 #endif /* !KERNEL */
185 #endif /* DRIVERKIT */
186
187 #endif /* !_NET_ETHERNET_H_ */
188