1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)if_ethersubr.c	8.1 (Berkeley) 6/10/93
32  * $FreeBSD: stable/12/sys/net/if_ethersubr.c 373215 2023-09-20 10:10:13Z zlei $
33  */
34 
35 #include "opt_inet.h"
36 #include "opt_inet6.h"
37 #include "opt_netgraph.h"
38 #include "opt_mbuf_profiling.h"
39 #include "opt_rss.h"
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/bus.h>
44 #include <sys/eventhandler.h>
45 #include <sys/jail.h>
46 #include <sys/kernel.h>
47 #include <sys/lock.h>
48 #include <sys/malloc.h>
49 #include <sys/module.h>
50 #include <sys/mbuf.h>
51 #include <sys/proc.h>
52 #include <sys/priv.h>
53 #include <sys/random.h>
54 #include <sys/socket.h>
55 #include <sys/sockio.h>
56 #include <sys/sysctl.h>
57 #include <sys/uuid.h>
58 
59 #include <net/ieee_oui.h>
60 #include <net/if.h>
61 #include <net/if_var.h>
62 #include <net/if_arp.h>
63 #include <net/netisr.h>
64 #include <net/route.h>
65 #include <net/if_llc.h>
66 #include <net/if_dl.h>
67 #include <net/if_types.h>
68 #include <net/bpf.h>
69 #include <net/ethernet.h>
70 #include <net/if_bridgevar.h>
71 #include <net/if_vlan_var.h>
72 #include <net/if_llatbl.h>
73 #include <net/pfil.h>
74 #include <net/rss_config.h>
75 #include <net/vnet.h>
76 
77 #include <netpfil/pf/pf_mtag.h>
78 
79 #if defined(INET) || defined(INET6)
80 #include <netinet/in.h>
81 #include <netinet/in_var.h>
82 #include <netinet/if_ether.h>
83 #include <netinet/ip_carp.h>
84 #include <netinet/ip_var.h>
85 #endif
86 #ifdef INET6
87 #include <netinet6/nd6.h>
88 #endif
89 #include <security/mac/mac_framework.h>
90 
91 #include <crypto/sha1.h>
92 
93 #ifdef CTASSERT
94 CTASSERT(sizeof (struct ether_header) == ETHER_ADDR_LEN * 2 + 2);
95 CTASSERT(sizeof (struct ether_addr) == ETHER_ADDR_LEN);
96 #endif
97 
98 VNET_DEFINE(struct pfil_head, link_pfil_hook);	/* Packet filter hooks */
99 
100 /* netgraph node hooks for ng_ether(4) */
101 void	(*ng_ether_input_p)(struct ifnet *ifp, struct mbuf **mp);
102 void	(*ng_ether_input_orphan_p)(struct ifnet *ifp, struct mbuf *m);
103 int	(*ng_ether_output_p)(struct ifnet *ifp, struct mbuf **mp);
104 void	(*ng_ether_attach_p)(struct ifnet *ifp);
105 void	(*ng_ether_detach_p)(struct ifnet *ifp);
106 
107 void	(*vlan_input_p)(struct ifnet *, struct mbuf *);
108 
109 /* if_bridge(4) support */
110 void	(*bridge_dn_p)(struct mbuf *, struct ifnet *);
111 
112 /* if_lagg(4) support */
113 struct mbuf *(*lagg_input_ethernet_p)(struct ifnet *, struct mbuf *);
114 
115 static const u_char etherbroadcastaddr[ETHER_ADDR_LEN] =
116 			{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
117 
118 static	int ether_resolvemulti(struct ifnet *, struct sockaddr **,
119 		struct sockaddr *);
120 static	int ether_requestencap(struct ifnet *, struct if_encap_req *);
121 
122 static inline bool ether_do_pcp(struct ifnet *, struct mbuf *);
123 
124 #define senderr(e) do { error = (e); goto bad;} while (0)
125 
126 static void
update_mbuf_csumflags(struct mbuf * src,struct mbuf * dst)127 update_mbuf_csumflags(struct mbuf *src, struct mbuf *dst)
128 {
129 	int csum_flags = 0;
130 
131 	if (src->m_pkthdr.csum_flags & CSUM_IP)
132 		csum_flags |= (CSUM_IP_CHECKED|CSUM_IP_VALID);
133 	if (src->m_pkthdr.csum_flags & CSUM_DELAY_DATA)
134 		csum_flags |= (CSUM_DATA_VALID|CSUM_PSEUDO_HDR);
135 	if (src->m_pkthdr.csum_flags & CSUM_SCTP)
136 		csum_flags |= CSUM_SCTP_VALID;
137 	dst->m_pkthdr.csum_flags |= csum_flags;
138 	if (csum_flags & CSUM_DATA_VALID)
139 		dst->m_pkthdr.csum_data = 0xffff;
140 }
141 
142 /*
143  * Handle link-layer encapsulation requests.
144  */
145 static int
ether_requestencap(struct ifnet * ifp,struct if_encap_req * req)146 ether_requestencap(struct ifnet *ifp, struct if_encap_req *req)
147 {
148 	struct ether_header *eh;
149 	struct arphdr *ah;
150 	uint16_t etype;
151 	const u_char *lladdr;
152 
153 	if (req->rtype != IFENCAP_LL)
154 		return (EOPNOTSUPP);
155 
156 	if (req->bufsize < ETHER_HDR_LEN)
157 		return (ENOMEM);
158 
159 	eh = (struct ether_header *)req->buf;
160 	lladdr = req->lladdr;
161 	req->lladdr_off = 0;
162 
163 	switch (req->family) {
164 	case AF_INET:
165 		etype = htons(ETHERTYPE_IP);
166 		break;
167 	case AF_INET6:
168 		etype = htons(ETHERTYPE_IPV6);
169 		break;
170 	case AF_ARP:
171 		ah = (struct arphdr *)req->hdata;
172 		ah->ar_hrd = htons(ARPHRD_ETHER);
173 
174 		switch(ntohs(ah->ar_op)) {
175 		case ARPOP_REVREQUEST:
176 		case ARPOP_REVREPLY:
177 			etype = htons(ETHERTYPE_REVARP);
178 			break;
179 		case ARPOP_REQUEST:
180 		case ARPOP_REPLY:
181 		default:
182 			etype = htons(ETHERTYPE_ARP);
183 			break;
184 		}
185 
186 		if (req->flags & IFENCAP_FLAG_BROADCAST)
187 			lladdr = ifp->if_broadcastaddr;
188 		break;
189 	default:
190 		return (EAFNOSUPPORT);
191 	}
192 
193 	memcpy(&eh->ether_type, &etype, sizeof(eh->ether_type));
194 	memcpy(eh->ether_dhost, lladdr, ETHER_ADDR_LEN);
195 	memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
196 	req->bufsize = sizeof(struct ether_header);
197 
198 	return (0);
199 }
200 
201 
202 static int
ether_resolve_addr(struct ifnet * ifp,struct mbuf * m,const struct sockaddr * dst,struct route * ro,u_char * phdr,uint32_t * pflags,struct llentry ** plle)203 ether_resolve_addr(struct ifnet *ifp, struct mbuf *m,
204 	const struct sockaddr *dst, struct route *ro, u_char *phdr,
205 	uint32_t *pflags, struct llentry **plle)
206 {
207 	struct ether_header *eh;
208 	uint32_t lleflags = 0;
209 	int error = 0;
210 #if defined(INET) || defined(INET6)
211 	uint16_t etype;
212 #endif
213 
214 	if (plle)
215 		*plle = NULL;
216 	eh = (struct ether_header *)phdr;
217 
218 	switch (dst->sa_family) {
219 #ifdef INET
220 	case AF_INET:
221 		if ((m->m_flags & (M_BCAST | M_MCAST)) == 0)
222 			error = arpresolve(ifp, 0, m, dst, phdr, &lleflags,
223 			    plle);
224 		else {
225 			if (m->m_flags & M_BCAST)
226 				memcpy(eh->ether_dhost, ifp->if_broadcastaddr,
227 				    ETHER_ADDR_LEN);
228 			else {
229 				const struct in_addr *a;
230 				a = &(((const struct sockaddr_in *)dst)->sin_addr);
231 				ETHER_MAP_IP_MULTICAST(a, eh->ether_dhost);
232 			}
233 			etype = htons(ETHERTYPE_IP);
234 			memcpy(&eh->ether_type, &etype, sizeof(etype));
235 			memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
236 		}
237 		break;
238 #endif
239 #ifdef INET6
240 	case AF_INET6:
241 		if ((m->m_flags & M_MCAST) == 0)
242 			error = nd6_resolve(ifp, 0, m, dst, phdr, &lleflags,
243 			    plle);
244 		else {
245 			const struct in6_addr *a6;
246 			a6 = &(((const struct sockaddr_in6 *)dst)->sin6_addr);
247 			ETHER_MAP_IPV6_MULTICAST(a6, eh->ether_dhost);
248 			etype = htons(ETHERTYPE_IPV6);
249 			memcpy(&eh->ether_type, &etype, sizeof(etype));
250 			memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
251 		}
252 		break;
253 #endif
254 	default:
255 		if_printf(ifp, "can't handle af%d\n", dst->sa_family);
256 		if (m != NULL)
257 			m_freem(m);
258 		return (EAFNOSUPPORT);
259 	}
260 
261 	if (error == EHOSTDOWN) {
262 		if (ro != NULL && (ro->ro_flags & RT_HAS_GW) != 0)
263 			error = EHOSTUNREACH;
264 	}
265 
266 	if (error != 0)
267 		return (error);
268 
269 	*pflags = RT_MAY_LOOP;
270 	if (lleflags & LLE_IFADDR)
271 		*pflags |= RT_L2_ME;
272 
273 	return (0);
274 }
275 
276 /*
277  * Ethernet output routine.
278  * Encapsulate a packet of type family for the local net.
279  * Use trailer local net encapsulation if enough data in first
280  * packet leaves a multiple of 512 bytes of data in remainder.
281  */
282 int
ether_output(struct ifnet * ifp,struct mbuf * m,const struct sockaddr * dst,struct route * ro)283 ether_output(struct ifnet *ifp, struct mbuf *m,
284 	const struct sockaddr *dst, struct route *ro)
285 {
286 	int error = 0;
287 	char linkhdr[ETHER_HDR_LEN], *phdr;
288 	struct ether_header *eh;
289 	struct pf_mtag *t;
290 	bool loop_copy;
291 	int hlen;	/* link layer header length */
292 	uint32_t pflags;
293 	struct llentry *lle = NULL;
294 	int addref = 0;
295 
296 	phdr = NULL;
297 	pflags = 0;
298 	if (ro != NULL) {
299 		/* XXX BPF uses ro_prepend */
300 		if (ro->ro_prepend != NULL) {
301 			phdr = ro->ro_prepend;
302 			hlen = ro->ro_plen;
303 		} else if (!(m->m_flags & (M_BCAST | M_MCAST))) {
304 			if ((ro->ro_flags & RT_LLE_CACHE) != 0) {
305 				lle = ro->ro_lle;
306 				if (lle != NULL &&
307 				    (lle->la_flags & LLE_VALID) == 0) {
308 					LLE_FREE(lle);
309 					lle = NULL;	/* redundant */
310 					ro->ro_lle = NULL;
311 				}
312 				if (lle == NULL) {
313 					/* if we lookup, keep cache */
314 					addref = 1;
315 				} else
316 					/*
317 					 * Notify LLE code that
318 					 * the entry was used
319 					 * by datapath.
320 					 */
321 					llentry_mark_used(lle);
322 			}
323 			if (lle != NULL) {
324 				phdr = lle->r_linkdata;
325 				hlen = lle->r_hdrlen;
326 				pflags = lle->r_flags;
327 			}
328 		}
329 	}
330 
331 #ifdef MAC
332 	error = mac_ifnet_check_transmit(ifp, m);
333 	if (error)
334 		senderr(error);
335 #endif
336 
337 	M_PROFILE(m);
338 	if (ifp->if_flags & IFF_MONITOR)
339 		senderr(ENETDOWN);
340 	if (!((ifp->if_flags & IFF_UP) &&
341 	    (ifp->if_drv_flags & IFF_DRV_RUNNING)))
342 		senderr(ENETDOWN);
343 
344 	if (phdr == NULL) {
345 		/* No prepend data supplied. Try to calculate ourselves. */
346 		phdr = linkhdr;
347 		hlen = ETHER_HDR_LEN;
348 		error = ether_resolve_addr(ifp, m, dst, ro, phdr, &pflags,
349 		    addref ? &lle : NULL);
350 		if (addref && lle != NULL)
351 			ro->ro_lle = lle;
352 		if (error != 0)
353 			return (error == EWOULDBLOCK ? 0 : error);
354 	}
355 
356 	if ((pflags & RT_L2_ME) != 0) {
357 		update_mbuf_csumflags(m, m);
358 		return (if_simloop(ifp, m, dst->sa_family, 0));
359 	}
360 	loop_copy = (pflags & RT_MAY_LOOP) != 0;
361 
362 	/*
363 	 * Add local net header.  If no space in first mbuf,
364 	 * allocate another.
365 	 *
366 	 * Note that we do prepend regardless of RT_HAS_HEADER flag.
367 	 * This is done because BPF code shifts m_data pointer
368 	 * to the end of ethernet header prior to calling if_output().
369 	 */
370 	M_PREPEND(m, hlen, M_NOWAIT);
371 	if (m == NULL)
372 		senderr(ENOBUFS);
373 	if ((pflags & RT_HAS_HEADER) == 0) {
374 		eh = mtod(m, struct ether_header *);
375 		memcpy(eh, phdr, hlen);
376 	}
377 
378 	/*
379 	 * If a simplex interface, and the packet is being sent to our
380 	 * Ethernet address or a broadcast address, loopback a copy.
381 	 * XXX To make a simplex device behave exactly like a duplex
382 	 * device, we should copy in the case of sending to our own
383 	 * ethernet address (thus letting the original actually appear
384 	 * on the wire). However, we don't do that here for security
385 	 * reasons and compatibility with the original behavior.
386 	 */
387 	if ((m->m_flags & M_BCAST) && loop_copy && (ifp->if_flags & IFF_SIMPLEX) &&
388 	    ((t = pf_find_mtag(m)) == NULL || !t->routed)) {
389 		struct mbuf *n;
390 
391 		/*
392 		 * Because if_simloop() modifies the packet, we need a
393 		 * writable copy through m_dup() instead of a readonly
394 		 * one as m_copy[m] would give us. The alternative would
395 		 * be to modify if_simloop() to handle the readonly mbuf,
396 		 * but performancewise it is mostly equivalent (trading
397 		 * extra data copying vs. extra locking).
398 		 *
399 		 * XXX This is a local workaround.  A number of less
400 		 * often used kernel parts suffer from the same bug.
401 		 * See PR kern/105943 for a proposed general solution.
402 		 */
403 		if ((n = m_dup(m, M_NOWAIT)) != NULL) {
404 			update_mbuf_csumflags(m, n);
405 			(void)if_simloop(ifp, n, dst->sa_family, hlen);
406 		} else
407 			if_inc_counter(ifp, IFCOUNTER_IQDROPS, 1);
408 	}
409 
410        /*
411 	* Bridges require special output handling.
412 	*/
413 	if (ifp->if_bridge) {
414 		BRIDGE_OUTPUT(ifp, m, error);
415 		return (error);
416 	}
417 
418 #if defined(INET) || defined(INET6)
419 	if (ifp->if_carp &&
420 	    (error = (*carp_output_p)(ifp, m, dst)))
421 		goto bad;
422 #endif
423 
424 	/* Handle ng_ether(4) processing, if any */
425 	if (ifp->if_l2com != NULL) {
426 		KASSERT(ng_ether_output_p != NULL,
427 		    ("ng_ether_output_p is NULL"));
428 		if ((error = (*ng_ether_output_p)(ifp, &m)) != 0) {
429 bad:			if (m != NULL)
430 				m_freem(m);
431 			return (error);
432 		}
433 		if (m == NULL)
434 			return (0);
435 	}
436 
437 	/* Continue with link-layer output */
438 	return ether_output_frame(ifp, m);
439 }
440 
441 static bool
ether_set_pcp(struct mbuf ** mp,struct ifnet * ifp,uint8_t pcp)442 ether_set_pcp(struct mbuf **mp, struct ifnet *ifp, uint8_t pcp)
443 {
444 	struct ether_header *eh;
445 
446 	eh = mtod(*mp, struct ether_header *);
447 	if (eh->ether_type == htons(ETHERTYPE_VLAN)) {
448 		(*mp)->m_flags &= ~M_VLANTAG;
449 		return (true);
450 	}
451 	if (ether_8021q_frame(mp, ifp, ifp, 0, pcp))
452 		return (true);
453 	if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
454 	return (false);
455 }
456 
457 /*
458  * Ethernet link layer output routine to send a raw frame to the device.
459  *
460  * This assumes that the 14 byte Ethernet header is present and contiguous
461  * in the first mbuf (if BRIDGE'ing).
462  */
463 int
ether_output_frame(struct ifnet * ifp,struct mbuf * m)464 ether_output_frame(struct ifnet *ifp, struct mbuf *m)
465 {
466 	int error;
467 
468 	if (ether_do_pcp(ifp, m) && !ether_set_pcp(&m, ifp, ifp->if_pcp))
469 		return (0);
470 
471 	if (PFIL_HOOKED(&V_link_pfil_hook)) {
472 		error = pfil_run_hooks(&V_link_pfil_hook, &m, ifp,
473 		    PFIL_OUT, 0, NULL);
474 		if (error != 0)
475 			return (EACCES);
476 
477 		if (m == NULL)
478 			return (0);
479 	}
480 
481 	/*
482 	 * Queue message on interface, update output statistics if
483 	 * successful, and start output if interface not yet active.
484 	 */
485 	return ((ifp->if_transmit)(ifp, m));
486 }
487 
488 /*
489  * Process a received Ethernet packet; the packet is in the
490  * mbuf chain m with the ethernet header at the front.
491  */
492 static void
ether_input_internal(struct ifnet * ifp,struct mbuf * m)493 ether_input_internal(struct ifnet *ifp, struct mbuf *m)
494 {
495 	struct ether_header *eh;
496 	u_short etype;
497 
498 	if ((ifp->if_flags & IFF_UP) == 0) {
499 		m_freem(m);
500 		return;
501 	}
502 #ifdef DIAGNOSTIC
503 	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
504 		if_printf(ifp, "discard frame at !IFF_DRV_RUNNING\n");
505 		m_freem(m);
506 		return;
507 	}
508 #endif
509 	if (m->m_len < ETHER_HDR_LEN) {
510 		/* XXX maybe should pullup? */
511 		if_printf(ifp, "discard frame w/o leading ethernet "
512 				"header (len %u pkt len %u)\n",
513 				m->m_len, m->m_pkthdr.len);
514 		if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
515 		m_freem(m);
516 		return;
517 	}
518 	eh = mtod(m, struct ether_header *);
519 	etype = ntohs(eh->ether_type);
520 	random_harvest_queue_ether(m, sizeof(*m));
521 
522 	CURVNET_SET_QUIET(ifp->if_vnet);
523 
524 	if (ETHER_IS_MULTICAST(eh->ether_dhost)) {
525 		if (ETHER_IS_BROADCAST(eh->ether_dhost))
526 			m->m_flags |= M_BCAST;
527 		else
528 			m->m_flags |= M_MCAST;
529 		if_inc_counter(ifp, IFCOUNTER_IMCASTS, 1);
530 	}
531 
532 #ifdef MAC
533 	/*
534 	 * Tag the mbuf with an appropriate MAC label before any other
535 	 * consumers can get to it.
536 	 */
537 	mac_ifnet_create_mbuf(ifp, m);
538 #endif
539 
540 	/*
541 	 * Give bpf a chance at the packet.
542 	 */
543 	ETHER_BPF_MTAP(ifp, m);
544 
545 	/*
546 	 * If the CRC is still on the packet, trim it off. We do this once
547 	 * and once only in case we are re-entered. Nothing else on the
548 	 * Ethernet receive path expects to see the FCS.
549 	 */
550 	if (m->m_flags & M_HASFCS) {
551 		m_adj(m, -ETHER_CRC_LEN);
552 		m->m_flags &= ~M_HASFCS;
553 	}
554 
555 	if (!(ifp->if_capenable & IFCAP_HWSTATS))
556 		if_inc_counter(ifp, IFCOUNTER_IBYTES, m->m_pkthdr.len);
557 
558 	/* Allow monitor mode to claim this frame, after stats are updated. */
559 	if (ifp->if_flags & IFF_MONITOR) {
560 		m_freem(m);
561 		CURVNET_RESTORE();
562 		return;
563 	}
564 
565 	/* Handle input from a lagg(4) port */
566 	if (ifp->if_type == IFT_IEEE8023ADLAG) {
567 		KASSERT(lagg_input_ethernet_p != NULL,
568 		    ("%s: if_lagg not loaded!", __func__));
569 		m = (*lagg_input_ethernet_p)(ifp, m);
570 		if (m != NULL)
571 			ifp = m->m_pkthdr.rcvif;
572 		else {
573 			CURVNET_RESTORE();
574 			return;
575 		}
576 	}
577 
578 	/*
579 	 * If the hardware did not process an 802.1Q tag, do this now,
580 	 * to allow 802.1P priority frames to be passed to the main input
581 	 * path correctly.
582 	 * TODO: Deal with Q-in-Q frames, but not arbitrary nesting levels.
583 	 */
584 	if ((m->m_flags & M_VLANTAG) == 0 && etype == ETHERTYPE_VLAN) {
585 		struct ether_vlan_header *evl;
586 
587 		if (m->m_len < sizeof(*evl) &&
588 		    (m = m_pullup(m, sizeof(*evl))) == NULL) {
589 #ifdef DIAGNOSTIC
590 			if_printf(ifp, "cannot pullup VLAN header\n");
591 #endif
592 			if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
593 			CURVNET_RESTORE();
594 			return;
595 		}
596 
597 		evl = mtod(m, struct ether_vlan_header *);
598 		m->m_pkthdr.ether_vtag = ntohs(evl->evl_tag);
599 		m->m_flags |= M_VLANTAG;
600 
601 		bcopy((char *)evl, (char *)evl + ETHER_VLAN_ENCAP_LEN,
602 		    ETHER_HDR_LEN - ETHER_TYPE_LEN);
603 		m_adj(m, ETHER_VLAN_ENCAP_LEN);
604 		eh = mtod(m, struct ether_header *);
605 	}
606 
607 	M_SETFIB(m, ifp->if_fib);
608 
609 	/* Allow ng_ether(4) to claim this frame. */
610 	if (ifp->if_l2com != NULL) {
611 		KASSERT(ng_ether_input_p != NULL,
612 		    ("%s: ng_ether_input_p is NULL", __func__));
613 		m->m_flags &= ~M_PROMISC;
614 		(*ng_ether_input_p)(ifp, &m);
615 		if (m == NULL) {
616 			CURVNET_RESTORE();
617 			return;
618 		}
619 		eh = mtod(m, struct ether_header *);
620 	}
621 
622 	/*
623 	 * Allow if_bridge(4) to claim this frame.
624 	 * The BRIDGE_INPUT() macro will update ifp if the bridge changed it
625 	 * and the frame should be delivered locally.
626 	 */
627 	if (ifp->if_bridge != NULL) {
628 		m->m_flags &= ~M_PROMISC;
629 		BRIDGE_INPUT(ifp, m);
630 		if (m == NULL) {
631 			CURVNET_RESTORE();
632 			return;
633 		}
634 		eh = mtod(m, struct ether_header *);
635 	}
636 
637 #if defined(INET) || defined(INET6)
638 	/*
639 	 * Clear M_PROMISC on frame so that carp(4) will see it when the
640 	 * mbuf flows up to Layer 3.
641 	 * FreeBSD's implementation of carp(4) uses the inprotosw
642 	 * to dispatch IPPROTO_CARP. carp(4) also allocates its own
643 	 * Ethernet addresses of the form 00:00:5e:00:01:xx, which
644 	 * is outside the scope of the M_PROMISC test below.
645 	 * TODO: Maintain a hash table of ethernet addresses other than
646 	 * ether_dhost which may be active on this ifp.
647 	 */
648 	if (ifp->if_carp && (*carp_forus_p)(ifp, eh->ether_dhost)) {
649 		m->m_flags &= ~M_PROMISC;
650 	} else
651 #endif
652 	{
653 		/*
654 		 * If the frame received was not for our MAC address, set the
655 		 * M_PROMISC flag on the mbuf chain. The frame may need to
656 		 * be seen by the rest of the Ethernet input path in case of
657 		 * re-entry (e.g. bridge, vlan, netgraph) but should not be
658 		 * seen by upper protocol layers.
659 		 */
660 		if (!ETHER_IS_MULTICAST(eh->ether_dhost) &&
661 		    bcmp(IF_LLADDR(ifp), eh->ether_dhost, ETHER_ADDR_LEN) != 0)
662 			m->m_flags |= M_PROMISC;
663 	}
664 
665 	ether_demux(ifp, m);
666 	CURVNET_RESTORE();
667 }
668 
669 /*
670  * Ethernet input dispatch; by default, direct dispatch here regardless of
671  * global configuration.  However, if RSS is enabled, hook up RSS affinity
672  * so that when deferred or hybrid dispatch is enabled, we can redistribute
673  * load based on RSS.
674  *
675  * XXXRW: Would be nice if the ifnet passed up a flag indicating whether or
676  * not it had already done work distribution via multi-queue.  Then we could
677  * direct dispatch in the event load balancing was already complete and
678  * handle the case of interfaces with different capabilities better.
679  *
680  * XXXRW: Sort of want an M_DISTRIBUTED flag to avoid multiple distributions
681  * at multiple layers?
682  *
683  * XXXRW: For now, enable all this only if RSS is compiled in, although it
684  * works fine without RSS.  Need to characterise the performance overhead
685  * of the detour through the netisr code in the event the result is always
686  * direct dispatch.
687  */
688 static void
ether_nh_input(struct mbuf * m)689 ether_nh_input(struct mbuf *m)
690 {
691 
692 	M_ASSERTPKTHDR(m);
693 	KASSERT(m->m_pkthdr.rcvif != NULL,
694 	    ("%s: NULL interface pointer", __func__));
695 	ether_input_internal(m->m_pkthdr.rcvif, m);
696 }
697 
698 static struct netisr_handler	ether_nh = {
699 	.nh_name = "ether",
700 	.nh_handler = ether_nh_input,
701 	.nh_proto = NETISR_ETHER,
702 #ifdef RSS
703 	.nh_policy = NETISR_POLICY_CPU,
704 	.nh_dispatch = NETISR_DISPATCH_DIRECT,
705 	.nh_m2cpuid = rss_m2cpuid,
706 #else
707 	.nh_policy = NETISR_POLICY_SOURCE,
708 	.nh_dispatch = NETISR_DISPATCH_DIRECT,
709 #endif
710 };
711 
712 static void
ether_init(__unused void * arg)713 ether_init(__unused void *arg)
714 {
715 
716 	netisr_register(&ether_nh);
717 }
718 SYSINIT(ether, SI_SUB_INIT_IF, SI_ORDER_ANY, ether_init, NULL);
719 
720 static void
vnet_ether_init(__unused void * arg)721 vnet_ether_init(__unused void *arg)
722 {
723 	int i;
724 
725 	/* Initialize packet filter hooks. */
726 	V_link_pfil_hook.ph_type = PFIL_TYPE_AF;
727 	V_link_pfil_hook.ph_af = AF_LINK;
728 	if ((i = pfil_head_register(&V_link_pfil_hook)) != 0)
729 		printf("%s: WARNING: unable to register pfil link hook, "
730 			"error %d\n", __func__, i);
731 #ifdef VIMAGE
732 	netisr_register_vnet(&ether_nh);
733 #endif
734 }
735 VNET_SYSINIT(vnet_ether_init, SI_SUB_PROTO_IF, SI_ORDER_ANY,
736     vnet_ether_init, NULL);
737 
738 #ifdef VIMAGE
739 static void
vnet_ether_pfil_destroy(__unused void * arg)740 vnet_ether_pfil_destroy(__unused void *arg)
741 {
742 	int i;
743 
744 	if ((i = pfil_head_unregister(&V_link_pfil_hook)) != 0)
745 		printf("%s: WARNING: unable to unregister pfil link hook, "
746 			"error %d\n", __func__, i);
747 }
748 VNET_SYSUNINIT(vnet_ether_pfil_uninit, SI_SUB_PROTO_PFIL, SI_ORDER_ANY,
749     vnet_ether_pfil_destroy, NULL);
750 
751 static void
vnet_ether_destroy(__unused void * arg)752 vnet_ether_destroy(__unused void *arg)
753 {
754 
755 	netisr_unregister_vnet(&ether_nh);
756 }
757 VNET_SYSUNINIT(vnet_ether_uninit, SI_SUB_PROTO_IF, SI_ORDER_ANY,
758     vnet_ether_destroy, NULL);
759 #endif
760 
761 
762 
763 static void
ether_input(struct ifnet * ifp,struct mbuf * m)764 ether_input(struct ifnet *ifp, struct mbuf *m)
765 {
766 
767 	struct mbuf *mn;
768 
769 	/*
770 	 * The drivers are allowed to pass in a chain of packets linked with
771 	 * m_nextpkt. We split them up into separate packets here and pass
772 	 * them up. This allows the drivers to amortize the receive lock.
773 	 */
774 	while (m) {
775 		mn = m->m_nextpkt;
776 		m->m_nextpkt = NULL;
777 
778 		/*
779 		 * We will rely on rcvif being set properly in the deferred context,
780 		 * so assert it is correct here.
781 		 */
782 		KASSERT(m->m_pkthdr.rcvif == ifp, ("%s: ifnet mismatch m %p "
783 		    "rcvif %p ifp %p", __func__, m, m->m_pkthdr.rcvif, ifp));
784 		CURVNET_SET_QUIET(ifp->if_vnet);
785 		netisr_dispatch(NETISR_ETHER, m);
786 		CURVNET_RESTORE();
787 		m = mn;
788 	}
789 }
790 
791 /*
792  * Upper layer processing for a received Ethernet packet.
793  */
794 void
ether_demux(struct ifnet * ifp,struct mbuf * m)795 ether_demux(struct ifnet *ifp, struct mbuf *m)
796 {
797 	struct ether_header *eh;
798 	int i, isr;
799 	u_short ether_type;
800 
801 	KASSERT(ifp != NULL, ("%s: NULL interface pointer", __func__));
802 
803 	/* Do not grab PROMISC frames in case we are re-entered. */
804 	if (PFIL_HOOKED(&V_link_pfil_hook) && !(m->m_flags & M_PROMISC)) {
805 		i = pfil_run_hooks(&V_link_pfil_hook, &m, ifp, PFIL_IN, 0,
806 		    NULL);
807 
808 		if (i != 0 || m == NULL)
809 			return;
810 	}
811 
812 	eh = mtod(m, struct ether_header *);
813 	ether_type = ntohs(eh->ether_type);
814 
815 	/*
816 	 * If this frame has a VLAN tag other than 0, call vlan_input()
817 	 * if its module is loaded. Otherwise, drop.
818 	 */
819 	if ((m->m_flags & M_VLANTAG) &&
820 	    EVL_VLANOFTAG(m->m_pkthdr.ether_vtag) != 0) {
821 		if (ifp->if_vlantrunk == NULL) {
822 			if_inc_counter(ifp, IFCOUNTER_NOPROTO, 1);
823 			m_freem(m);
824 			return;
825 		}
826 		KASSERT(vlan_input_p != NULL,("%s: VLAN not loaded!",
827 		    __func__));
828 		/* Clear before possibly re-entering ether_input(). */
829 		m->m_flags &= ~M_PROMISC;
830 		(*vlan_input_p)(ifp, m);
831 		return;
832 	}
833 
834 	/*
835 	 * Pass promiscuously received frames to the upper layer if the user
836 	 * requested this by setting IFF_PPROMISC. Otherwise, drop them.
837 	 */
838 	if ((ifp->if_flags & IFF_PPROMISC) == 0 && (m->m_flags & M_PROMISC)) {
839 		m_freem(m);
840 		return;
841 	}
842 
843 	/*
844 	 * Reset layer specific mbuf flags to avoid confusing upper layers.
845 	 * Strip off Ethernet header.
846 	 */
847 	m->m_flags &= ~M_VLANTAG;
848 	m_clrprotoflags(m);
849 	m_adj(m, ETHER_HDR_LEN);
850 
851 	/*
852 	 * Dispatch frame to upper layer.
853 	 */
854 	switch (ether_type) {
855 #ifdef INET
856 	case ETHERTYPE_IP:
857 		isr = NETISR_IP;
858 		break;
859 
860 	case ETHERTYPE_ARP:
861 		if (ifp->if_flags & IFF_NOARP) {
862 			/* Discard packet if ARP is disabled on interface */
863 			m_freem(m);
864 			return;
865 		}
866 		isr = NETISR_ARP;
867 		break;
868 #endif
869 #ifdef INET6
870 	case ETHERTYPE_IPV6:
871 		isr = NETISR_IPV6;
872 		break;
873 #endif
874 	default:
875 		goto discard;
876 	}
877 	netisr_dispatch(isr, m);
878 	return;
879 
880 discard:
881 	/*
882 	 * Packet is to be discarded.  If netgraph is present,
883 	 * hand the packet to it for last chance processing;
884 	 * otherwise dispose of it.
885 	 */
886 	if (ifp->if_l2com != NULL) {
887 		KASSERT(ng_ether_input_orphan_p != NULL,
888 		    ("ng_ether_input_orphan_p is NULL"));
889 		/*
890 		 * Put back the ethernet header so netgraph has a
891 		 * consistent view of inbound packets.
892 		 */
893 		M_PREPEND(m, ETHER_HDR_LEN, M_NOWAIT);
894 		(*ng_ether_input_orphan_p)(ifp, m);
895 		return;
896 	}
897 	m_freem(m);
898 }
899 
900 /*
901  * Convert Ethernet address to printable (loggable) representation.
902  * This routine is for compatibility; it's better to just use
903  *
904  *	printf("%6D", <pointer to address>, ":");
905  *
906  * since there's no static buffer involved.
907  */
908 char *
ether_sprintf(const u_char * ap)909 ether_sprintf(const u_char *ap)
910 {
911 	static char etherbuf[18];
912 	snprintf(etherbuf, sizeof (etherbuf), "%6D", ap, ":");
913 	return (etherbuf);
914 }
915 
916 /*
917  * Perform common duties while attaching to interface list
918  */
919 void
ether_ifattach(struct ifnet * ifp,const u_int8_t * lla)920 ether_ifattach(struct ifnet *ifp, const u_int8_t *lla)
921 {
922 	int i;
923 	struct ifaddr *ifa;
924 	struct sockaddr_dl *sdl;
925 
926 	ifp->if_addrlen = ETHER_ADDR_LEN;
927 	ifp->if_hdrlen = ETHER_HDR_LEN;
928 	ifp->if_mtu = ETHERMTU;
929 	if_attach(ifp);
930 	ifp->if_output = ether_output;
931 	ifp->if_input = ether_input;
932 	ifp->if_resolvemulti = ether_resolvemulti;
933 	ifp->if_requestencap = ether_requestencap;
934 #ifdef VIMAGE
935 	ifp->if_reassign = ether_reassign;
936 #endif
937 	if (ifp->if_baudrate == 0)
938 		ifp->if_baudrate = IF_Mbps(10);		/* just a default */
939 	ifp->if_broadcastaddr = etherbroadcastaddr;
940 
941 	ifa = ifp->if_addr;
942 	KASSERT(ifa != NULL, ("%s: no lladdr!\n", __func__));
943 	sdl = (struct sockaddr_dl *)ifa->ifa_addr;
944 	sdl->sdl_type = IFT_ETHER;
945 	sdl->sdl_alen = ifp->if_addrlen;
946 	bcopy(lla, LLADDR(sdl), ifp->if_addrlen);
947 
948 	if (ifp->if_hw_addr != NULL)
949 		bcopy(lla, ifp->if_hw_addr, ifp->if_addrlen);
950 
951 	bpfattach(ifp, DLT_EN10MB, ETHER_HDR_LEN);
952 	if (ng_ether_attach_p != NULL)
953 		(*ng_ether_attach_p)(ifp);
954 
955 	/* Announce Ethernet MAC address if non-zero. */
956 	for (i = 0; i < ifp->if_addrlen; i++)
957 		if (lla[i] != 0)
958 			break;
959 	if (i != ifp->if_addrlen)
960 		if_printf(ifp, "Ethernet address: %6D\n", lla, ":");
961 
962 	uuid_ether_add(LLADDR(sdl));
963 
964 	/* Add necessary bits are setup; announce it now. */
965 	EVENTHANDLER_INVOKE(ether_ifattach_event, ifp);
966 	if (IS_DEFAULT_VNET(curvnet))
967 		devctl_notify("ETHERNET", ifp->if_xname, "IFATTACH", NULL);
968 }
969 
970 /*
971  * Perform common duties while detaching an Ethernet interface
972  */
973 void
ether_ifdetach(struct ifnet * ifp)974 ether_ifdetach(struct ifnet *ifp)
975 {
976 	struct sockaddr_dl *sdl;
977 
978 	sdl = (struct sockaddr_dl *)(ifp->if_addr->ifa_addr);
979 	uuid_ether_del(LLADDR(sdl));
980 
981 	if (ifp->if_l2com != NULL) {
982 		KASSERT(ng_ether_detach_p != NULL,
983 		    ("ng_ether_detach_p is NULL"));
984 		(*ng_ether_detach_p)(ifp);
985 	}
986 
987 	bpfdetach(ifp);
988 	if_detach(ifp);
989 }
990 
991 #ifdef VIMAGE
992 void
ether_reassign(struct ifnet * ifp,struct vnet * new_vnet,char * unused __unused)993 ether_reassign(struct ifnet *ifp, struct vnet *new_vnet, char *unused __unused)
994 {
995 
996 	if (ifp->if_l2com != NULL) {
997 		KASSERT(ng_ether_detach_p != NULL,
998 		    ("ng_ether_detach_p is NULL"));
999 		(*ng_ether_detach_p)(ifp);
1000 	}
1001 
1002 	if (ng_ether_attach_p != NULL) {
1003 		CURVNET_SET_QUIET(new_vnet);
1004 		(*ng_ether_attach_p)(ifp);
1005 		CURVNET_RESTORE();
1006 	}
1007 }
1008 #endif
1009 
1010 SYSCTL_DECL(_net_link);
1011 SYSCTL_NODE(_net_link, IFT_ETHER, ether, CTLFLAG_RW, 0, "Ethernet");
1012 
1013 #if 0
1014 /*
1015  * This is for reference.  We have a table-driven version
1016  * of the little-endian crc32 generator, which is faster
1017  * than the double-loop.
1018  */
1019 uint32_t
1020 ether_crc32_le(const uint8_t *buf, size_t len)
1021 {
1022 	size_t i;
1023 	uint32_t crc;
1024 	int bit;
1025 	uint8_t data;
1026 
1027 	crc = 0xffffffff;	/* initial value */
1028 
1029 	for (i = 0; i < len; i++) {
1030 		for (data = *buf++, bit = 0; bit < 8; bit++, data >>= 1) {
1031 			carry = (crc ^ data) & 1;
1032 			crc >>= 1;
1033 			if (carry)
1034 				crc = (crc ^ ETHER_CRC_POLY_LE);
1035 		}
1036 	}
1037 
1038 	return (crc);
1039 }
1040 #else
1041 uint32_t
ether_crc32_le(const uint8_t * buf,size_t len)1042 ether_crc32_le(const uint8_t *buf, size_t len)
1043 {
1044 	static const uint32_t crctab[] = {
1045 		0x00000000, 0x1db71064, 0x3b6e20c8, 0x26d930ac,
1046 		0x76dc4190, 0x6b6b51f4, 0x4db26158, 0x5005713c,
1047 		0xedb88320, 0xf00f9344, 0xd6d6a3e8, 0xcb61b38c,
1048 		0x9b64c2b0, 0x86d3d2d4, 0xa00ae278, 0xbdbdf21c
1049 	};
1050 	size_t i;
1051 	uint32_t crc;
1052 
1053 	crc = 0xffffffff;	/* initial value */
1054 
1055 	for (i = 0; i < len; i++) {
1056 		crc ^= buf[i];
1057 		crc = (crc >> 4) ^ crctab[crc & 0xf];
1058 		crc = (crc >> 4) ^ crctab[crc & 0xf];
1059 	}
1060 
1061 	return (crc);
1062 }
1063 #endif
1064 
1065 uint32_t
ether_crc32_be(const uint8_t * buf,size_t len)1066 ether_crc32_be(const uint8_t *buf, size_t len)
1067 {
1068 	size_t i;
1069 	uint32_t crc, carry;
1070 	int bit;
1071 	uint8_t data;
1072 
1073 	crc = 0xffffffff;	/* initial value */
1074 
1075 	for (i = 0; i < len; i++) {
1076 		for (data = *buf++, bit = 0; bit < 8; bit++, data >>= 1) {
1077 			carry = ((crc & 0x80000000) ? 1 : 0) ^ (data & 0x01);
1078 			crc <<= 1;
1079 			if (carry)
1080 				crc = (crc ^ ETHER_CRC_POLY_BE) | carry;
1081 		}
1082 	}
1083 
1084 	return (crc);
1085 }
1086 
1087 int
ether_ioctl(struct ifnet * ifp,u_long command,caddr_t data)1088 ether_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
1089 {
1090 	struct ifaddr *ifa = (struct ifaddr *) data;
1091 	struct ifreq *ifr = (struct ifreq *) data;
1092 	int error = 0;
1093 
1094 	switch (command) {
1095 	case SIOCSIFADDR:
1096 		ifp->if_flags |= IFF_UP;
1097 
1098 		switch (ifa->ifa_addr->sa_family) {
1099 #ifdef INET
1100 		case AF_INET:
1101 			ifp->if_init(ifp->if_softc);	/* before arpwhohas */
1102 			arp_ifinit(ifp, ifa);
1103 			break;
1104 #endif
1105 		default:
1106 			ifp->if_init(ifp->if_softc);
1107 			break;
1108 		}
1109 		break;
1110 
1111 	case SIOCGIFADDR:
1112 		bcopy(IF_LLADDR(ifp), &ifr->ifr_addr.sa_data[0],
1113 		    ETHER_ADDR_LEN);
1114 		break;
1115 
1116 	case SIOCSIFMTU:
1117 		/*
1118 		 * Set the interface MTU.
1119 		 */
1120 		if (ifr->ifr_mtu > ETHERMTU) {
1121 			error = EINVAL;
1122 		} else {
1123 			ifp->if_mtu = ifr->ifr_mtu;
1124 		}
1125 		break;
1126 
1127 	case SIOCSLANPCP:
1128 		error = priv_check(curthread, PRIV_NET_SETLANPCP);
1129 		if (error != 0)
1130 			break;
1131 		if (ifr->ifr_lan_pcp > 7 &&
1132 		    ifr->ifr_lan_pcp != IFNET_PCP_NONE) {
1133 			error = EINVAL;
1134 		} else {
1135 			ifp->if_pcp = ifr->ifr_lan_pcp;
1136 			/* broadcast event about PCP change */
1137 			EVENTHANDLER_INVOKE(ifnet_event, ifp, IFNET_EVENT_PCP);
1138 		}
1139 		break;
1140 
1141 	case SIOCGLANPCP:
1142 		ifr->ifr_lan_pcp = ifp->if_pcp;
1143 		break;
1144 
1145 	default:
1146 		error = EINVAL;			/* XXX netbsd has ENOTTY??? */
1147 		break;
1148 	}
1149 	return (error);
1150 }
1151 
1152 static int
ether_resolvemulti(struct ifnet * ifp,struct sockaddr ** llsa,struct sockaddr * sa)1153 ether_resolvemulti(struct ifnet *ifp, struct sockaddr **llsa,
1154 	struct sockaddr *sa)
1155 {
1156 	struct sockaddr_dl *sdl;
1157 #ifdef INET
1158 	struct sockaddr_in *sin;
1159 #endif
1160 #ifdef INET6
1161 	struct sockaddr_in6 *sin6;
1162 #endif
1163 	u_char *e_addr;
1164 
1165 	switch(sa->sa_family) {
1166 	case AF_LINK:
1167 		/*
1168 		 * No mapping needed. Just check that it's a valid MC address.
1169 		 */
1170 		sdl = (struct sockaddr_dl *)sa;
1171 		e_addr = LLADDR(sdl);
1172 		if (!ETHER_IS_MULTICAST(e_addr))
1173 			return EADDRNOTAVAIL;
1174 		*llsa = NULL;
1175 		return 0;
1176 
1177 #ifdef INET
1178 	case AF_INET:
1179 		sin = (struct sockaddr_in *)sa;
1180 		if (!IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
1181 			return EADDRNOTAVAIL;
1182 		sdl = link_init_sdl(ifp, *llsa, IFT_ETHER);
1183 		sdl->sdl_alen = ETHER_ADDR_LEN;
1184 		e_addr = LLADDR(sdl);
1185 		ETHER_MAP_IP_MULTICAST(&sin->sin_addr, e_addr);
1186 		*llsa = (struct sockaddr *)sdl;
1187 		return 0;
1188 #endif
1189 #ifdef INET6
1190 	case AF_INET6:
1191 		sin6 = (struct sockaddr_in6 *)sa;
1192 		if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
1193 			/*
1194 			 * An IP6 address of 0 means listen to all
1195 			 * of the Ethernet multicast address used for IP6.
1196 			 * (This is used for multicast routers.)
1197 			 */
1198 			ifp->if_flags |= IFF_ALLMULTI;
1199 			*llsa = NULL;
1200 			return 0;
1201 		}
1202 		if (!IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
1203 			return EADDRNOTAVAIL;
1204 		sdl = link_init_sdl(ifp, *llsa, IFT_ETHER);
1205 		sdl->sdl_alen = ETHER_ADDR_LEN;
1206 		e_addr = LLADDR(sdl);
1207 		ETHER_MAP_IPV6_MULTICAST(&sin6->sin6_addr, e_addr);
1208 		*llsa = (struct sockaddr *)sdl;
1209 		return 0;
1210 #endif
1211 
1212 	default:
1213 		/*
1214 		 * Well, the text isn't quite right, but it's the name
1215 		 * that counts...
1216 		 */
1217 		return EAFNOSUPPORT;
1218 	}
1219 }
1220 
1221 static moduledata_t ether_mod = {
1222 	.name = "ether",
1223 };
1224 
1225 void
ether_vlan_mtap(struct bpf_if * bp,struct mbuf * m,void * data,u_int dlen)1226 ether_vlan_mtap(struct bpf_if *bp, struct mbuf *m, void *data, u_int dlen)
1227 {
1228 	struct ether_vlan_header vlan;
1229 	struct mbuf mv, mb;
1230 
1231 	KASSERT((m->m_flags & M_VLANTAG) != 0,
1232 	    ("%s: vlan information not present", __func__));
1233 	KASSERT(m->m_len >= sizeof(struct ether_header),
1234 	    ("%s: mbuf not large enough for header", __func__));
1235 	bcopy(mtod(m, char *), &vlan, sizeof(struct ether_header));
1236 	vlan.evl_proto = vlan.evl_encap_proto;
1237 	vlan.evl_encap_proto = htons(ETHERTYPE_VLAN);
1238 	vlan.evl_tag = htons(m->m_pkthdr.ether_vtag);
1239 	m->m_len -= sizeof(struct ether_header);
1240 	m->m_data += sizeof(struct ether_header);
1241 	/*
1242 	 * If a data link has been supplied by the caller, then we will need to
1243 	 * re-create a stack allocated mbuf chain with the following structure:
1244 	 *
1245 	 * (1) mbuf #1 will contain the supplied data link
1246 	 * (2) mbuf #2 will contain the vlan header
1247 	 * (3) mbuf #3 will contain the original mbuf's packet data
1248 	 *
1249 	 * Otherwise, submit the packet and vlan header via bpf_mtap2().
1250 	 */
1251 	if (data != NULL) {
1252 		mv.m_next = m;
1253 		mv.m_data = (caddr_t)&vlan;
1254 		mv.m_len = sizeof(vlan);
1255 		mb.m_next = &mv;
1256 		mb.m_data = data;
1257 		mb.m_len = dlen;
1258 		bpf_mtap(bp, &mb);
1259 	} else
1260 		bpf_mtap2(bp, &vlan, sizeof(vlan), m);
1261 	m->m_len += sizeof(struct ether_header);
1262 	m->m_data -= sizeof(struct ether_header);
1263 }
1264 
1265 struct mbuf *
ether_vlanencap(struct mbuf * m,uint16_t tag)1266 ether_vlanencap(struct mbuf *m, uint16_t tag)
1267 {
1268 	struct ether_vlan_header *evl;
1269 
1270 	M_PREPEND(m, ETHER_VLAN_ENCAP_LEN, M_NOWAIT);
1271 	if (m == NULL)
1272 		return (NULL);
1273 	/* M_PREPEND takes care of m_len, m_pkthdr.len for us */
1274 
1275 	if (m->m_len < sizeof(*evl)) {
1276 		m = m_pullup(m, sizeof(*evl));
1277 		if (m == NULL)
1278 			return (NULL);
1279 	}
1280 
1281 	/*
1282 	 * Transform the Ethernet header into an Ethernet header
1283 	 * with 802.1Q encapsulation.
1284 	 */
1285 	evl = mtod(m, struct ether_vlan_header *);
1286 	bcopy((char *)evl + ETHER_VLAN_ENCAP_LEN,
1287 	    (char *)evl, ETHER_HDR_LEN - ETHER_TYPE_LEN);
1288 	evl->evl_encap_proto = htons(ETHERTYPE_VLAN);
1289 	evl->evl_tag = htons(tag);
1290 	return (m);
1291 }
1292 
1293 static SYSCTL_NODE(_net_link, IFT_L2VLAN, vlan, CTLFLAG_RW, 0,
1294     "IEEE 802.1Q VLAN");
1295 static SYSCTL_NODE(_net_link_vlan, PF_LINK, link, CTLFLAG_RW, 0,
1296     "for consistency");
1297 
1298 VNET_DEFINE_STATIC(int, soft_pad);
1299 #define	V_soft_pad	VNET(soft_pad)
1300 SYSCTL_INT(_net_link_vlan, OID_AUTO, soft_pad, CTLFLAG_RW | CTLFLAG_VNET,
1301     &VNET_NAME(soft_pad), 0,
1302     "pad short frames before tagging");
1303 
1304 /*
1305  * For now, make preserving PCP via an mbuf tag optional, as it increases
1306  * per-packet memory allocations and frees.  In the future, it would be
1307  * preferable to reuse ether_vtag for this, or similar.
1308  */
1309 int vlan_mtag_pcp = 0;
1310 SYSCTL_INT(_net_link_vlan, OID_AUTO, mtag_pcp, CTLFLAG_RW,
1311     &vlan_mtag_pcp, 0,
1312     "Retain VLAN PCP information as packets are passed up the stack");
1313 
1314 static inline bool
ether_do_pcp(struct ifnet * ifp,struct mbuf * m)1315 ether_do_pcp(struct ifnet *ifp, struct mbuf *m)
1316 {
1317 	if (ifp->if_type == IFT_L2VLAN)
1318 		return (false);
1319 	if (ifp->if_pcp != IFNET_PCP_NONE || (m->m_flags & M_VLANTAG) != 0)
1320 		return (true);
1321 	if (vlan_mtag_pcp &&
1322 	    m_tag_locate(m, MTAG_8021Q, MTAG_8021Q_PCP_OUT, NULL) != NULL)
1323 		return (true);
1324 	return (false);
1325 }
1326 
1327 bool
ether_8021q_frame(struct mbuf ** mp,struct ifnet * ife,struct ifnet * p,uint16_t vid,uint8_t pcp)1328 ether_8021q_frame(struct mbuf **mp, struct ifnet *ife, struct ifnet *p,
1329     uint16_t vid, uint8_t pcp)
1330 {
1331 	struct m_tag *mtag;
1332 	int n;
1333 	uint16_t tag;
1334 	static const char pad[8];	/* just zeros */
1335 
1336 	/*
1337 	 * Pad the frame to the minimum size allowed if told to.
1338 	 * This option is in accord with IEEE Std 802.1Q, 2003 Ed.,
1339 	 * paragraph C.4.4.3.b.  It can help to work around buggy
1340 	 * bridges that violate paragraph C.4.4.3.a from the same
1341 	 * document, i.e., fail to pad short frames after untagging.
1342 	 * E.g., a tagged frame 66 bytes long (incl. FCS) is OK, but
1343 	 * untagging it will produce a 62-byte frame, which is a runt
1344 	 * and requires padding.  There are VLAN-enabled network
1345 	 * devices that just discard such runts instead or mishandle
1346 	 * them somehow.
1347 	 */
1348 	if (V_soft_pad && p->if_type == IFT_ETHER) {
1349 		for (n = ETHERMIN + ETHER_HDR_LEN - (*mp)->m_pkthdr.len;
1350 		     n > 0; n -= sizeof(pad)) {
1351 			if (!m_append(*mp, min(n, sizeof(pad)), pad))
1352 				break;
1353 		}
1354 		if (n > 0) {
1355 			m_freem(*mp);
1356 			*mp = NULL;
1357 			if_printf(ife, "cannot pad short frame");
1358 			return (false);
1359 		}
1360 	}
1361 
1362 	/*
1363 	 * If PCP is set in mbuf, use it
1364 	 */
1365 	if ((*mp)->m_flags & M_VLANTAG) {
1366 		pcp = EVL_PRIOFTAG((*mp)->m_pkthdr.ether_vtag);
1367 	}
1368 
1369 	/*
1370 	 * If underlying interface can do VLAN tag insertion itself,
1371 	 * just pass the packet along. However, we need some way to
1372 	 * tell the interface where the packet came from so that it
1373 	 * knows how to find the VLAN tag to use, so we attach a
1374 	 * packet tag that holds it.
1375 	 */
1376 	if (vlan_mtag_pcp && (mtag = m_tag_locate(*mp, MTAG_8021Q,
1377 	    MTAG_8021Q_PCP_OUT, NULL)) != NULL)
1378 		tag = EVL_MAKETAG(vid, *(uint8_t *)(mtag + 1), 0);
1379 	else
1380 		tag = EVL_MAKETAG(vid, pcp, 0);
1381 	if (p->if_capenable & IFCAP_VLAN_HWTAGGING) {
1382 		(*mp)->m_pkthdr.ether_vtag = tag;
1383 		(*mp)->m_flags |= M_VLANTAG;
1384 	} else {
1385 		*mp = ether_vlanencap(*mp, tag);
1386 		if (*mp == NULL) {
1387 			if_printf(ife, "unable to prepend 802.1Q header");
1388 			return (false);
1389 		}
1390 		(*mp)->m_flags &= ~M_VLANTAG;
1391 	}
1392 	return (true);
1393 }
1394 
1395 /*
1396  * Allocate an address from the FreeBSD Foundation OUI.  This uses a
1397  * cryptographic hash function on the containing jail's name, UUID and the
1398  * interface name to attempt to provide a unique but stable address.
1399  * Pseudo-interfaces which require a MAC address should use this function to
1400  * allocate non-locally-administered addresses.
1401  */
1402 void
ether_gen_addr(struct ifnet * ifp,struct ether_addr * hwaddr)1403 ether_gen_addr(struct ifnet *ifp, struct ether_addr *hwaddr)
1404 {
1405 	SHA1_CTX ctx;
1406 	char *buf;
1407 	char uuid[HOSTUUIDLEN + 1];
1408 	uint64_t addr;
1409 	int i, sz;
1410 	char digest[SHA1_RESULTLEN];
1411 	char jailname[MAXHOSTNAMELEN];
1412 
1413 	getcredhostuuid(curthread->td_ucred, uuid, sizeof(uuid));
1414 	if (strncmp(uuid, DEFAULT_HOSTUUID, sizeof(uuid)) == 0) {
1415 		/* Fall back to a random mac address. */
1416 		goto rando;
1417 	}
1418 
1419 	/* If each (vnet) jail would also have a unique hostuuid this would not
1420 	 * be necessary. */
1421 	getjailname(curthread->td_ucred, jailname, sizeof(jailname));
1422 	sz = asprintf(&buf, M_TEMP, "%s-%s-%s", uuid, if_name(ifp),
1423 	    jailname);
1424 	if (sz < 0) {
1425 		/* Fall back to a random mac address. */
1426 		goto rando;
1427 	}
1428 
1429 	SHA1Init(&ctx);
1430 	SHA1Update(&ctx, buf, sz);
1431 	SHA1Final(digest, &ctx);
1432 	free(buf, M_TEMP);
1433 
1434 	addr = ((digest[0] << 16) | (digest[1] << 8) | digest[2]) &
1435 	    OUI_FREEBSD_GENERATED_MASK;
1436 	addr = OUI_FREEBSD(addr);
1437 	for (i = 0; i < ETHER_ADDR_LEN; ++i) {
1438 		hwaddr->octet[i] = addr >> ((ETHER_ADDR_LEN - i - 1) * 8) &
1439 		    0xFF;
1440 	}
1441 
1442 	return;
1443 rando:
1444 	arc4rand(hwaddr, sizeof(*hwaddr), 0);
1445 	/* Unicast */
1446 	hwaddr->octet[0] &= 0xFE;
1447 	/* Locally administered. */
1448 	hwaddr->octet[0] |= 0x02;
1449 }
1450 
1451 DECLARE_MODULE(ether, ether_mod, SI_SUB_INIT_IF, SI_ORDER_ANY);
1452 MODULE_VERSION(ether, 1);
1453