1 /* $OpenBSD: if_ether.h,v 1.17 2001/06/27 06:07:47 kjc Exp $ */ 2 /* $NetBSD: if_ether.h,v 1.22 1996/05/11 13:00:00 mycroft Exp $ */ 3 4 /* 5 * Copyright (c) 1982, 1986, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)if_ether.h 8.1 (Berkeley) 6/10/93 37 */ 38 39 #ifndef _NETINET_IF_ETHER_H_ 40 #define _NETINET_IF_ETHER_H_ 41 42 /* 43 * Ethernet address - 6 octets 44 * this is only used by the ethers(3) functions. 45 */ 46 struct ether_addr { 47 u_int8_t ether_addr_octet[6]; 48 }; 49 50 /* 51 * Some Ethernet constants. 52 */ 53 #define ETHER_ADDR_LEN 6 /* Ethernet address length */ 54 #define ETHER_TYPE_LEN 2 /* Ethernet type field length */ 55 #define ETHER_CRC_LEN 4 /* Ethernet CRC lenght */ 56 #define ETHER_HDR_LEN ((ETHER_ADDR_LEN * 2) + ETHER_TYPE_LEN) 57 #define ETHER_MIN_LEN 64 /* Minimum frame length, CRC included */ 58 #define ETHER_MAX_LEN 1518 /* Maximum frame length, CRC included */ 59 60 /* 61 * The length of the combined header. 62 */ 63 64 struct ether_header { 65 u_int8_t ether_dhost[ETHER_ADDR_LEN]; 66 u_int8_t ether_shost[ETHER_ADDR_LEN]; 67 u_int16_t ether_type; 68 }; 69 70 #define ETHERTYPE_PUP 0x0200 /* PUP protocol */ 71 #define ETHERTYPE_IP 0x0800 /* IP protocol */ 72 #define ETHERTYPE_ARP 0x0806 /* address resolution protocol */ 73 #define ETHERTYPE_REVARP 0x8035 /* reverse addr resolution protocol */ 74 #define ETHERTYPE_8021Q 0x8100 /* IEEE 802.1Q VLAN tagging */ 75 #define ETHERTYPE_IPV6 0x86DD /* IPv6 protocol */ 76 #define ETHERTYPE_PPPOEDISC 0x8863 /* PPP Over Ethernet Discovery Stage */ 77 #define ETHERTYPE_PPPOE 0x8864 /* PPP Over Ethernet Session Stage */ 78 #define ETHERTYPE_LOOPBACK 0x9000 /* used to test interfaces */ 79 80 /* 81 * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have 82 * (type-ETHERTYPE_TRAIL)*512 bytes of data followed 83 * by an ETHER type (as given above) and then the (variable-length) header. 84 */ 85 #define ETHERTYPE_TRAIL 0x1000 /* Trailer packet */ 86 #define ETHERTYPE_NTRAILER 16 87 88 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ 89 90 #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 91 #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 92 93 #ifdef _KERNEL 94 /* 95 * Macro to map an IP multicast address to an Ethernet multicast address. 96 * The high-order 25 bits of the Ethernet address are statically assigned, 97 * and the low-order 23 bits are taken from the low end of the IP address. 98 */ 99 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ 100 /* struct in_addr *ipaddr; */ \ 101 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 102 { \ 103 (enaddr)[0] = 0x01; \ 104 (enaddr)[1] = 0x00; \ 105 (enaddr)[2] = 0x5e; \ 106 (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \ 107 (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \ 108 (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \ 109 } 110 111 /* 112 * Macro to map an IPv6 multicast address to an Ethernet multicast address. 113 * The high-order 16 bits of the Ethernet address are statically assigned, 114 * and the low-order 32 bits are taken from the low end of the IPv6 address. 115 */ 116 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \ 117 /* struct in6_addr *ip6addr; */ \ 118 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 119 { \ 120 (enaddr)[0] = 0x33; \ 121 (enaddr)[1] = 0x33; \ 122 (enaddr)[2] = ((u_int8_t *)ip6addr)[12]; \ 123 (enaddr)[3] = ((u_int8_t *)ip6addr)[13]; \ 124 (enaddr)[4] = ((u_int8_t *)ip6addr)[14]; \ 125 (enaddr)[5] = ((u_int8_t *)ip6addr)[15]; \ 126 } 127 #endif 128 129 /* 130 * Ethernet Address Resolution Protocol. 131 * 132 * See RFC 826 for protocol description. Structure below is adapted 133 * to resolving internet addresses. Field names used correspond to 134 * RFC 826. 135 */ 136 struct ether_arp { 137 struct arphdr ea_hdr; /* fixed-size header */ 138 u_int8_t arp_sha[ETHER_ADDR_LEN]; /* sender hardware address */ 139 u_int8_t arp_spa[4]; /* sender protocol address */ 140 u_int8_t arp_tha[ETHER_ADDR_LEN]; /* target hardware address */ 141 u_int8_t arp_tpa[4]; /* target protocol address */ 142 }; 143 #define arp_hrd ea_hdr.ar_hrd 144 #define arp_pro ea_hdr.ar_pro 145 #define arp_hln ea_hdr.ar_hln 146 #define arp_pln ea_hdr.ar_pln 147 #define arp_op ea_hdr.ar_op 148 149 /* 150 * Structure shared between the ethernet driver modules and 151 * the address resolution code. For example, each ec_softc or il_softc 152 * begins with this structure. 153 */ 154 struct arpcom { 155 struct ifnet ac_if; /* network-visible interface */ 156 u_int8_t ac_enaddr[ETHER_ADDR_LEN]; /* ethernet hardware address */ 157 char ac__pad[2]; /* pad for some machines */ 158 LIST_HEAD(, ether_multi) ac_multiaddrs; /* list of ether multicast addrs */ 159 int ac_multicnt; /* length of ac_multiaddrs list */ 160 }; 161 162 struct llinfo_arp { 163 LIST_ENTRY(llinfo_arp) la_list; 164 struct rtentry *la_rt; 165 struct mbuf *la_hold; /* last packet until resolved/timeout */ 166 long la_asked; /* last time we QUERIED for this addr */ 167 #define la_timer la_rt->rt_rmx.rmx_expire /* deletion time in seconds */ 168 }; 169 170 struct sockaddr_inarp { 171 u_int8_t sin_len; 172 u_int8_t sin_family; 173 u_int16_t sin_port; 174 struct in_addr sin_addr; 175 struct in_addr sin_srcaddr; 176 u_int16_t sin_tos; 177 u_int16_t sin_other; 178 #define SIN_PROXY 1 179 }; 180 181 /* 182 * IP and ethernet specific routing flags 183 */ 184 #define RTF_USETRAILERS RTF_PROTO1 /* use trailers */ 185 #define RTF_ANNOUNCE RTF_PROTO2 /* announce new arp entry */ 186 #define RTF_PERMANENT_ARP RTF_PROTO3 /* only manual overwrite of entry */ 187 188 #ifdef _KERNEL 189 u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN]; 190 u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; 191 u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; 192 struct ifqueue arpintrq; 193 194 void arpwhohas __P((struct arpcom *, struct in_addr *)); 195 void arpintr __P((void)); 196 int arpresolve __P((struct arpcom *, 197 struct rtentry *, struct mbuf *, struct sockaddr *, u_char *)); 198 void arp_ifinit __P((struct arpcom *, struct ifaddr *)); 199 void arp_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *)); 200 201 int ether_addmulti __P((struct ifreq *, struct arpcom *)); 202 int ether_delmulti __P((struct ifreq *, struct arpcom *)); 203 #endif /* _KERNEL */ 204 205 /* 206 * Ethernet multicast address structure. There is one of these for each 207 * multicast address or range of multicast addresses that we are supposed 208 * to listen to on a particular interface. They are kept in a linked list, 209 * rooted in the interface's arpcom structure. (This really has nothing to 210 * do with ARP, or with the Internet address family, but this appears to be 211 * the minimally-disrupting place to put it.) 212 */ 213 struct ether_multi { 214 u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low or only address of range */ 215 u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */ 216 struct arpcom *enm_ac; /* back pointer to arpcom */ 217 u_int enm_refcount; /* no. claims to this addr/range */ 218 LIST_ENTRY(ether_multi) enm_list; 219 }; 220 221 /* 222 * Structure used by macros below to remember position when stepping through 223 * all of the ether_multi records. 224 */ 225 struct ether_multistep { 226 struct ether_multi *e_enm; 227 }; 228 229 /* 230 * Macro for looking up the ether_multi record for a given range of Ethernet 231 * multicast addresses connected to a given arpcom structure. If no matching 232 * record is found, "enm" returns NULL. 233 */ 234 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \ 235 /* u_int8_t addrlo[ETHER_ADDR_LEN]; */ \ 236 /* u_int8_t addrhi[ETHER_ADDR_LEN]; */ \ 237 /* struct arpcom *ac; */ \ 238 /* struct ether_multi *enm; */ \ 239 { \ 240 for ((enm) = (ac)->ac_multiaddrs.lh_first; \ 241 (enm) != NULL && \ 242 (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 || \ 243 bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \ 244 (enm) = (enm)->enm_list.le_next); \ 245 } 246 247 /* 248 * Macro to step through all of the ether_multi records, one at a time. 249 * The current position is remembered in "step", which the caller must 250 * provide. ETHER_FIRST_MULTI(), below, must be called to initialize "step" 251 * and get the first record. Both macros return a NULL "enm" when there 252 * are no remaining records. 253 */ 254 #define ETHER_NEXT_MULTI(step, enm) \ 255 /* struct ether_multistep step; */ \ 256 /* struct ether_multi *enm; */ \ 257 { \ 258 if (((enm) = (step).e_enm) != NULL) \ 259 (step).e_enm = (enm)->enm_list.le_next; \ 260 } 261 262 #define ETHER_FIRST_MULTI(step, ac, enm) \ 263 /* struct ether_multistep step; */ \ 264 /* struct arpcom *ac; */ \ 265 /* struct ether_multi *enm; */ \ 266 { \ 267 (step).e_enm = (ac)->ac_multiaddrs.lh_first; \ 268 ETHER_NEXT_MULTI((step), (enm)); \ 269 } 270 271 #ifdef _KERNEL 272 273 extern struct ifnet *myip_ifp; 274 275 void arp_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *)); 276 int arpresolve __P((struct arpcom *, struct rtentry *, struct mbuf *, 277 struct sockaddr *, u_char *)); 278 void arpintr __P((void)); 279 int arpioctl __P((u_long, caddr_t)); 280 void arp_ifinit __P((struct arpcom *, struct ifaddr *)); 281 void arprequest __P((struct ifnet *, u_int32_t *, u_int32_t *, u_int8_t *)); 282 void revarpinput __P((struct mbuf *)); 283 void in_revarpinput __P((struct mbuf *)); 284 void revarprequest __P((struct ifnet *)); 285 int revarpwhoarewe __P((struct ifnet *, struct in_addr *, struct in_addr *)); 286 int revarpwhoami __P((struct in_addr *, struct ifnet *)); 287 int db_show_arptab __P((void)); 288 #ifdef ALTQ 289 void altq_etherclassify(struct ifaltq *, struct mbuf *, struct altq_pktattr *); 290 #endif /* ALTQ */ 291 292 #else 293 294 char *ether_ntoa __P((struct ether_addr *)); 295 struct ether_addr *ether_aton __P((char *)); 296 int ether_ntohost __P((char *, struct ether_addr *)); 297 int ether_hostton __P((char *, struct ether_addr *)); 298 int ether_line __P((char *, struct ether_addr *, char *)); 299 300 #endif /* _KERNEL */ 301 #endif /* _NETINET_IF_ETHER_H_ */ 302