xref: /freebsd/sys/netinet/if_ether.h (revision 61afd5bb22d787b0641523e7b9b95c964d669bd5)
1 /*
2  * Copyright (c) 1982, 1986, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)if_ether.h	8.3 (Berkeley) 5/2/95
34  *	$Id: if_ether.h,v 1.16 1996/12/11 17:46:33 wollman Exp $
35  */
36 
37 #ifndef _NETINET_IF_ETHER_H_
38 #define _NETINET_IF_ETHER_H_
39 
40 #include <net/ethernet.h>
41 #include <net/if_arp.h>
42 
43 #ifdef KERNEL
44 /*
45  * Macro to map an IP multicast address to an Ethernet multicast address.
46  * The high-order 25 bits of the Ethernet address are statically assigned,
47  * and the low-order 23 bits are taken from the low end of the IP address.
48  */
49 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
50 	/* struct in_addr *ipaddr; */ \
51 	/* u_char enaddr[ETHER_ADDR_LEN];	   */ \
52 { \
53 	(enaddr)[0] = 0x01; \
54 	(enaddr)[1] = 0x00; \
55 	(enaddr)[2] = 0x5e; \
56 	(enaddr)[3] = ((u_char *)ipaddr)[1] & 0x7f; \
57 	(enaddr)[4] = ((u_char *)ipaddr)[2]; \
58 	(enaddr)[5] = ((u_char *)ipaddr)[3]; \
59 }
60 #endif
61 
62 /*
63  * Ethernet Address Resolution Protocol.
64  *
65  * See RFC 826 for protocol description.  Structure below is adapted
66  * to resolving internet addresses.  Field names used correspond to
67  * RFC 826.
68  */
69 struct	ether_arp {
70 	struct	arphdr ea_hdr;	/* fixed-size header */
71 	u_char	arp_sha[ETHER_ADDR_LEN];	/* sender hardware address */
72 	u_char	arp_spa[4];	/* sender protocol address */
73 	u_char	arp_tha[ETHER_ADDR_LEN];	/* target hardware address */
74 	u_char	arp_tpa[4];	/* target protocol address */
75 };
76 #define	arp_hrd	ea_hdr.ar_hrd
77 #define	arp_pro	ea_hdr.ar_pro
78 #define	arp_hln	ea_hdr.ar_hln
79 #define	arp_pln	ea_hdr.ar_pln
80 #define	arp_op	ea_hdr.ar_op
81 
82 
83 /*
84  * Structure shared between the ethernet driver modules and
85  * the address resolution code.  For example, each ec_softc or il_softc
86  * begins with this structure.
87  */
88 struct	arpcom {
89 	/*
90 	 * The ifnet struct _must_ be at the head of this structure.
91 	 */
92 	struct 	ifnet ac_if;		/* network-visible interface */
93 	u_char	ac_enaddr[ETHER_ADDR_LEN];		/* ethernet hardware address */
94 	struct	ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
95 	int	ac_multicnt;		/* length of ac_multiaddrs list */
96 };
97 
98 struct sockaddr_inarp {
99 	u_char	sin_len;
100 	u_char	sin_family;
101 	u_short sin_port;
102 	struct	in_addr sin_addr;
103 	struct	in_addr sin_srcaddr;
104 	u_short	sin_tos;
105 	u_short	sin_other;
106 #define SIN_PROXY 1
107 };
108 /*
109  * IP and ethernet specific routing flags
110  */
111 #define	RTF_USETRAILERS	RTF_PROTO1	/* use trailers */
112 #define RTF_ANNOUNCE	RTF_PROTO2	/* announce new arp entry */
113 
114 #ifdef	KERNEL
115 extern u_char	etherbroadcastaddr[ETHER_ADDR_LEN];
116 extern u_char	ether_ipmulticast_min[ETHER_ADDR_LEN];
117 extern u_char	ether_ipmulticast_max[ETHER_ADDR_LEN];
118 extern struct	ifqueue arpintrq;
119 
120 int	arpresolve __P((struct arpcom *, struct rtentry *, struct mbuf *,
121 			struct sockaddr *, u_char *, struct rtentry *));
122 void	arp_ifinit __P((struct arpcom *, struct ifaddr *));
123 int	ether_addmulti __P((struct ifreq *, struct arpcom *));
124 int	ether_delmulti __P((struct ifreq *, struct arpcom *));
125 
126 /*
127  * Ethernet multicast address structure.  There is one of these for each
128  * multicast address or range of multicast addresses that we are supposed
129  * to listen to on a particular interface.  They are kept in a linked list,
130  * rooted in the interface's arpcom structure.  (This really has nothing to
131  * do with ARP, or with the Internet address family, but this appears to be
132  * the minimally-disrupting place to put it.)
133  */
134 struct ether_multi {
135 	u_char	enm_addrlo[ETHER_ADDR_LEN];		/* low  or only address of range */
136 	u_char	enm_addrhi[ETHER_ADDR_LEN];		/* high or only address of range */
137 	struct	arpcom *enm_ac;		/* back pointer to arpcom */
138 	u_int	enm_refcount;		/* no. claims to this addr/range */
139 	struct	ether_multi *enm_next;	/* ptr to next ether_multi */
140 };
141 
142 /*
143  * Structure used by macros below to remember position when stepping through
144  * all of the ether_multi records.
145  */
146 struct ether_multistep {
147 	struct ether_multi  *e_enm;
148 };
149 
150 /*
151  * Macro for looking up the ether_multi record for a given range of Ethernet
152  * multicast addresses connected to a given arpcom structure.  If no matching
153  * record is found, "enm" returns NULL.
154  */
155 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \
156 	/* u_char addrlo[ETHER_ADDR_LEN]; */ \
157 	/* u_char addrhi[ETHER_ADDR_LEN]; */ \
158 	/* struct arpcom *ac; */ \
159 	/* struct ether_multi *enm; */ \
160 { \
161 	for ((enm) = (ac)->ac_multiaddrs; \
162 	    (enm) != NULL && \
163 	    (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 || \
164 	     bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \
165 		(enm) = (enm)->enm_next); \
166 }
167 
168 /*
169  * Macro to step through all of the ether_multi records, one at a time.
170  * The current position is remembered in "step", which the caller must
171  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
172  * and get the first record.  Both macros return a NULL "enm" when there
173  * are no remaining records.
174  */
175 #define ETHER_NEXT_MULTI(step, enm) \
176 	/* struct ether_multistep step; */  \
177 	/* struct ether_multi *enm; */  \
178 { \
179 	if (((enm) = (step).e_enm) != NULL) \
180 		(step).e_enm = (enm)->enm_next; \
181 }
182 
183 #define ETHER_FIRST_MULTI(step, ac, enm) \
184 	/* struct ether_multistep step; */ \
185 	/* struct arpcom *ac; */ \
186 	/* struct ether_multi *enm; */ \
187 { \
188 	(step).e_enm = (ac)->ac_multiaddrs; \
189 	ETHER_NEXT_MULTI((step), (enm)); \
190 }
191 
192 #endif
193 
194 #endif
195