xref: /freebsd/sys/net/if_vlan.c (revision 3642298923e528d795e3a30ec165d2b469e28b40)
1 /*-
2  * Copyright 1998 Massachusetts Institute of Technology
3  *
4  * Permission to use, copy, modify, and distribute this software and
5  * its documentation for any purpose and without fee is hereby
6  * granted, provided that both the above copyright notice and this
7  * permission notice appear in all copies, that both the above
8  * copyright notice and this permission notice appear in all
9  * supporting documentation, and that the name of M.I.T. not be used
10  * in advertising or publicity pertaining to distribution of the
11  * software without specific, written prior permission.  M.I.T. makes
12  * no representations about the suitability of this software for any
13  * purpose.  It is provided "as is" without express or implied
14  * warranty.
15  *
16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 /*
33  * if_vlan.c - pseudo-device driver for IEEE 802.1Q virtual LANs.
34  * Might be extended some day to also handle IEEE 802.1p priority
35  * tagging.  This is sort of sneaky in the implementation, since
36  * we need to pretend to be enough of an Ethernet implementation
37  * to make arp work.  The way we do this is by telling everyone
38  * that we are an Ethernet, and then catch the packets that
39  * ether_output() left on our output queue when it calls
40  * if_start(), rewrite them for use by the real outgoing interface,
41  * and ask it to send them.
42  */
43 
44 #include "opt_inet.h"
45 
46 #include <sys/param.h>
47 #include <sys/kernel.h>
48 #include <sys/malloc.h>
49 #include <sys/mbuf.h>
50 #include <sys/module.h>
51 #include <sys/queue.h>
52 #include <sys/socket.h>
53 #include <sys/sockio.h>
54 #include <sys/sysctl.h>
55 #include <sys/systm.h>
56 
57 #include <net/bpf.h>
58 #include <net/ethernet.h>
59 #include <net/if.h>
60 #include <net/if_clone.h>
61 #include <net/if_arp.h>
62 #include <net/if_dl.h>
63 #include <net/if_types.h>
64 #include <net/if_vlan_var.h>
65 
66 #ifdef INET
67 #include <netinet/in.h>
68 #include <netinet/if_ether.h>
69 #endif
70 
71 #define VLANNAME	"vlan"
72 
73 struct vlan_mc_entry {
74 	struct ether_addr		mc_addr;
75 	SLIST_ENTRY(vlan_mc_entry)	mc_entries;
76 };
77 
78 struct	ifvlan {
79 	struct	ifnet *ifv_ifp;
80 	struct	ifnet *ifv_p;	/* parent inteface of this vlan */
81 	struct	ifv_linkmib {
82 		int	ifvm_parent;
83 		int	ifvm_encaplen;	/* encapsulation length */
84 		int	ifvm_mtufudge;	/* MTU fudged by this much */
85 		int	ifvm_mintu;	/* min transmission unit */
86 		u_int16_t ifvm_proto; /* encapsulation ethertype */
87 		u_int16_t ifvm_tag; /* tag to apply on packets leaving if */
88 	}	ifv_mib;
89 	SLIST_HEAD(__vlan_mchead, vlan_mc_entry)	vlan_mc_listhead;
90 	LIST_ENTRY(ifvlan) ifv_list;
91 	int	ifv_flags;
92 };
93 #define	ifv_tag	ifv_mib.ifvm_tag
94 #define	ifv_encaplen	ifv_mib.ifvm_encaplen
95 #define	ifv_mtufudge	ifv_mib.ifvm_mtufudge
96 #define	ifv_mintu	ifv_mib.ifvm_mintu
97 
98 #define	IFVF_PROMISC	0x01		/* promiscuous mode enabled */
99 
100 SYSCTL_DECL(_net_link);
101 SYSCTL_NODE(_net_link, IFT_L2VLAN, vlan, CTLFLAG_RW, 0, "IEEE 802.1Q VLAN");
102 SYSCTL_NODE(_net_link_vlan, PF_LINK, link, CTLFLAG_RW, 0, "for consistency");
103 
104 static MALLOC_DEFINE(M_VLAN, VLANNAME, "802.1Q Virtual LAN Interface");
105 static LIST_HEAD(, ifvlan) ifv_list;
106 
107 /*
108  * Locking: one lock is used to guard both the ifv_list and modification
109  * to vlan data structures.  We are rather conservative here; probably
110  * more than necessary.
111  */
112 static struct mtx ifv_mtx;
113 #define	VLAN_LOCK_INIT()	mtx_init(&ifv_mtx, VLANNAME, NULL, MTX_DEF)
114 #define	VLAN_LOCK_DESTROY()	mtx_destroy(&ifv_mtx)
115 #define	VLAN_LOCK_ASSERT()	mtx_assert(&ifv_mtx, MA_OWNED)
116 #define	VLAN_LOCK()	mtx_lock(&ifv_mtx)
117 #define	VLAN_UNLOCK()	mtx_unlock(&ifv_mtx)
118 
119 static	void vlan_start(struct ifnet *ifp);
120 static	void vlan_ifinit(void *foo);
121 static	void vlan_input(struct ifnet *ifp, struct mbuf *m);
122 static	int vlan_ioctl(struct ifnet *ifp, u_long cmd, caddr_t addr);
123 static	int vlan_setmulti(struct ifnet *ifp);
124 static	int vlan_unconfig(struct ifnet *ifp);
125 static	int vlan_config(struct ifvlan *ifv, struct ifnet *p);
126 static	void vlan_link_state(struct ifnet *ifp, int link);
127 static	int vlan_set_promisc(struct ifnet *ifp);
128 
129 static	struct ifnet *vlan_clone_match_ethertag(struct if_clone *,
130     const char *, int *);
131 static	int vlan_clone_match(struct if_clone *, const char *);
132 static	int vlan_clone_create(struct if_clone *, char *, size_t);
133 static	int vlan_clone_destroy(struct if_clone *, struct ifnet *);
134 
135 static	struct if_clone vlan_cloner = IFC_CLONE_INITIALIZER(VLANNAME, NULL,
136     IF_MAXUNIT, NULL, vlan_clone_match, vlan_clone_create, vlan_clone_destroy);
137 
138 /*
139  * Program our multicast filter. What we're actually doing is
140  * programming the multicast filter of the parent. This has the
141  * side effect of causing the parent interface to receive multicast
142  * traffic that it doesn't really want, which ends up being discarded
143  * later by the upper protocol layers. Unfortunately, there's no way
144  * to avoid this: there really is only one physical interface.
145  *
146  * XXX: There is a possible race here if more than one thread is
147  *      modifying the multicast state of the vlan interface at the same time.
148  */
149 static int
150 vlan_setmulti(struct ifnet *ifp)
151 {
152 	struct ifnet		*ifp_p;
153 	struct ifmultiaddr	*ifma, *rifma = NULL;
154 	struct ifvlan		*sc;
155 	struct vlan_mc_entry	*mc = NULL;
156 	struct sockaddr_dl	sdl;
157 	int			error;
158 
159 	/*VLAN_LOCK_ASSERT();*/
160 
161 	/* Find the parent. */
162 	sc = ifp->if_softc;
163 	ifp_p = sc->ifv_p;
164 
165 	/*
166 	 * If we don't have a parent, just remember the membership for
167 	 * when we do.
168 	 */
169 	if (ifp_p == NULL)
170 		return (0);
171 
172 	bzero((char *)&sdl, sizeof(sdl));
173 	sdl.sdl_len = sizeof(sdl);
174 	sdl.sdl_family = AF_LINK;
175 	sdl.sdl_index = ifp_p->if_index;
176 	sdl.sdl_type = IFT_ETHER;
177 	sdl.sdl_alen = ETHER_ADDR_LEN;
178 
179 	/* First, remove any existing filter entries. */
180 	while (SLIST_FIRST(&sc->vlan_mc_listhead) != NULL) {
181 		mc = SLIST_FIRST(&sc->vlan_mc_listhead);
182 		bcopy((char *)&mc->mc_addr, LLADDR(&sdl), ETHER_ADDR_LEN);
183 		error = if_delmulti(ifp_p, (struct sockaddr *)&sdl);
184 		if (error)
185 			return (error);
186 		SLIST_REMOVE_HEAD(&sc->vlan_mc_listhead, mc_entries);
187 		free(mc, M_VLAN);
188 	}
189 
190 	/* Now program new ones. */
191 	TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
192 		if (ifma->ifma_addr->sa_family != AF_LINK)
193 			continue;
194 		mc = malloc(sizeof(struct vlan_mc_entry), M_VLAN, M_NOWAIT);
195 		if (mc == NULL)
196 			return (ENOMEM);
197 		bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
198 		    (char *)&mc->mc_addr, ETHER_ADDR_LEN);
199 		SLIST_INSERT_HEAD(&sc->vlan_mc_listhead, mc, mc_entries);
200 		bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
201 		    LLADDR(&sdl), ETHER_ADDR_LEN);
202 		error = if_addmulti(ifp_p, (struct sockaddr *)&sdl, &rifma);
203 		if (error)
204 			return (error);
205 	}
206 
207 	return (0);
208 }
209 
210 /*
211  * VLAN support can be loaded as a module.  The only place in the
212  * system that's intimately aware of this is ether_input.  We hook
213  * into this code through vlan_input_p which is defined there and
214  * set here.  Noone else in the system should be aware of this so
215  * we use an explicit reference here.
216  *
217  * NB: Noone should ever need to check if vlan_input_p is null or
218  *     not.  This is because interfaces have a count of the number
219  *     of active vlans (if_nvlans) and this should never be bumped
220  *     except by vlan_config--which is in this module so therefore
221  *     the module must be loaded and vlan_input_p must be non-NULL.
222  */
223 extern	void (*vlan_input_p)(struct ifnet *, struct mbuf *);
224 
225 /* For if_link_state_change() eyes only... */
226 extern	void (*vlan_link_state_p)(struct ifnet *, int);
227 
228 static int
229 vlan_modevent(module_t mod, int type, void *data)
230 {
231 
232 	switch (type) {
233 	case MOD_LOAD:
234 		LIST_INIT(&ifv_list);
235 		VLAN_LOCK_INIT();
236 		vlan_input_p = vlan_input;
237 		vlan_link_state_p = vlan_link_state;
238 		if_clone_attach(&vlan_cloner);
239 		break;
240 	case MOD_UNLOAD:
241 		if_clone_detach(&vlan_cloner);
242 		vlan_input_p = NULL;
243 		vlan_link_state_p = NULL;
244 		while (!LIST_EMPTY(&ifv_list))
245 			vlan_clone_destroy(&vlan_cloner,
246 			    LIST_FIRST(&ifv_list)->ifv_ifp);
247 		VLAN_LOCK_DESTROY();
248 		break;
249 	default:
250 		return (EOPNOTSUPP);
251 	}
252 	return (0);
253 }
254 
255 static moduledata_t vlan_mod = {
256 	"if_vlan",
257 	vlan_modevent,
258 	0
259 };
260 
261 DECLARE_MODULE(if_vlan, vlan_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
262 MODULE_DEPEND(if_vlan, miibus, 1, 1, 1);
263 
264 static struct ifnet *
265 vlan_clone_match_ethertag(struct if_clone *ifc, const char *name, int *tag)
266 {
267 	const char *cp;
268 	struct ifnet *ifp;
269 	int t = 0;
270 
271 	/* Check for <etherif>.<vlan> style interface names. */
272 	IFNET_RLOCK();
273 	TAILQ_FOREACH(ifp, &ifnet, if_link) {
274 		if (ifp->if_type != IFT_ETHER)
275 			continue;
276 		if (strncmp(ifp->if_xname, name, strlen(ifp->if_xname)) != 0)
277 			continue;
278 		cp = name + strlen(ifp->if_xname);
279 		if (*cp != '.')
280 			continue;
281 		for(; *cp != '\0'; cp++) {
282 			if (*cp < '0' || *cp > '9')
283 				continue;
284 			t = (t * 10) + (*cp - '0');
285 		}
286 		if (tag != NULL)
287 			*tag = t;
288 		break;
289 	}
290 	IFNET_RUNLOCK();
291 
292 	return (ifp);
293 }
294 
295 static int
296 vlan_clone_match(struct if_clone *ifc, const char *name)
297 {
298 	const char *cp;
299 
300 	if (vlan_clone_match_ethertag(ifc, name, NULL) != NULL)
301 		return (1);
302 
303 	if (strncmp(VLANNAME, name, strlen(VLANNAME)) != 0)
304 		return (0);
305 	for (cp = name + 4; *cp != '\0'; cp++) {
306 		if (*cp < '0' || *cp > '9')
307 			return (0);
308 	}
309 
310 	return (1);
311 }
312 
313 static int
314 vlan_clone_create(struct if_clone *ifc, char *name, size_t len)
315 {
316 	char *dp;
317 	int wildcard;
318 	int unit;
319 	int error;
320 	int tag;
321 	int ethertag;
322 	struct ifvlan *ifv;
323 	struct ifnet *ifp;
324 	struct ifnet *p;
325 	u_char eaddr[6] = {0,0,0,0,0,0};
326 
327 	if ((p = vlan_clone_match_ethertag(ifc, name, &tag)) != NULL) {
328 		ethertag = 1;
329 		unit = -1;
330 		wildcard = 0;
331 
332 		/*
333 		 * Don't let the caller set up a VLAN tag with
334 		 * anything except VLID bits.
335 		 */
336 		if (tag & ~EVL_VLID_MASK)
337 			return (EINVAL);
338 	} else {
339 		ethertag = 0;
340 
341 		error = ifc_name2unit(name, &unit);
342 		if (error != 0)
343 			return (error);
344 
345 		wildcard = (unit < 0);
346 	}
347 
348 	error = ifc_alloc_unit(ifc, &unit);
349 	if (error != 0)
350 		return (error);
351 
352 	/* In the wildcard case, we need to update the name. */
353 	if (wildcard) {
354 		for (dp = name; *dp != '\0'; dp++);
355 		if (snprintf(dp, len - (dp-name), "%d", unit) >
356 		    len - (dp-name) - 1) {
357 			panic("%s: interface name too long", __func__);
358 		}
359 	}
360 
361 	ifv = malloc(sizeof(struct ifvlan), M_VLAN, M_WAITOK | M_ZERO);
362 	ifp = ifv->ifv_ifp = if_alloc(IFT_ETHER);
363 	if (ifp == NULL) {
364 		ifc_free_unit(ifc, unit);
365 		free(ifv, M_VLAN);
366 		return (ENOSPC);
367 	}
368 	SLIST_INIT(&ifv->vlan_mc_listhead);
369 
370 	ifp->if_softc = ifv;
371 	/*
372 	 * Set the name manually rather than using if_initname because
373 	 * we don't conform to the default naming convention for interfaces.
374 	 */
375 	strlcpy(ifp->if_xname, name, IFNAMSIZ);
376 	ifp->if_dname = ifc->ifc_name;
377 	ifp->if_dunit = unit;
378 	/* NB: flags are not set here */
379 	ifp->if_linkmib = &ifv->ifv_mib;
380 	ifp->if_linkmiblen = sizeof(ifv->ifv_mib);
381 	/* NB: mtu is not set here */
382 
383 	ifp->if_init = vlan_ifinit;
384 	ifp->if_start = vlan_start;
385 	ifp->if_ioctl = vlan_ioctl;
386 	ifp->if_snd.ifq_maxlen = ifqmaxlen;
387 	ether_ifattach(ifp, eaddr);
388 	/* Now undo some of the damage... */
389 	ifp->if_baudrate = 0;
390 	ifp->if_type = IFT_L2VLAN;
391 	ifp->if_hdrlen = ETHER_VLAN_ENCAP_LEN;
392 
393 	VLAN_LOCK();
394 	LIST_INSERT_HEAD(&ifv_list, ifv, ifv_list);
395 	VLAN_UNLOCK();
396 
397 	if (ethertag) {
398 		VLAN_LOCK();
399 		error = vlan_config(ifv, p);
400 		if (error != 0) {
401 			/*
402 			 * Since we've partialy failed, we need to back
403 			 * out all the way, otherwise userland could get
404 			 * confused.  Thus, we destroy the interface.
405 			 */
406 			LIST_REMOVE(ifv, ifv_list);
407 			vlan_unconfig(ifp);
408 			VLAN_UNLOCK();
409 			ether_ifdetach(ifp);
410 			if_free_type(ifp, IFT_ETHER);
411 			free(ifv, M_VLAN);
412 
413 			return (error);
414 		}
415 		ifv->ifv_tag = tag;
416 		ifp->if_drv_flags |= IFF_DRV_RUNNING;
417 		VLAN_UNLOCK();
418 
419 		/* Update promiscuous mode, if necessary. */
420 		vlan_set_promisc(ifp);
421 	}
422 
423 	return (0);
424 }
425 
426 static int
427 vlan_clone_destroy(struct if_clone *ifc, struct ifnet *ifp)
428 {
429 	int unit;
430 	struct ifvlan *ifv = ifp->if_softc;
431 
432 	unit = ifp->if_dunit;
433 
434 	VLAN_LOCK();
435 	LIST_REMOVE(ifv, ifv_list);
436 	vlan_unconfig(ifp);
437 	VLAN_UNLOCK();
438 
439 	ether_ifdetach(ifp);
440 	if_free_type(ifp, IFT_ETHER);
441 
442 	free(ifv, M_VLAN);
443 
444 	ifc_free_unit(ifc, unit);
445 
446 	return (0);
447 }
448 
449 /*
450  * The ifp->if_init entry point for vlan(4) is a no-op.
451  */
452 static void
453 vlan_ifinit(void *foo)
454 {
455 
456 }
457 
458 static void
459 vlan_start(struct ifnet *ifp)
460 {
461 	struct ifvlan *ifv;
462 	struct ifnet *p;
463 	struct ether_vlan_header *evl;
464 	struct mbuf *m;
465 	int error;
466 
467 	ifv = ifp->if_softc;
468 	p = ifv->ifv_p;
469 
470 	ifp->if_drv_flags |= IFF_DRV_OACTIVE;
471 	for (;;) {
472 		IF_DEQUEUE(&ifp->if_snd, m);
473 		if (m == 0)
474 			break;
475 		BPF_MTAP(ifp, m);
476 
477 		/*
478 		 * Do not run parent's if_start() if the parent is not up,
479 		 * or parent's driver will cause a system crash.
480 		 */
481 		if (!((p->if_flags & IFF_UP) &&
482 		    (p->if_drv_flags & IFF_DRV_RUNNING))) {
483 			m_freem(m);
484 			ifp->if_collisions++;
485 			continue;
486 		}
487 
488 		/*
489 		 * If underlying interface can do VLAN tag insertion itself,
490 		 * just pass the packet along. However, we need some way to
491 		 * tell the interface where the packet came from so that it
492 		 * knows how to find the VLAN tag to use, so we attach a
493 		 * packet tag that holds it.
494 		 */
495 		if (p->if_capenable & IFCAP_VLAN_HWTAGGING) {
496 			struct m_tag *mtag = m_tag_alloc(MTAG_VLAN,
497 							 MTAG_VLAN_TAG,
498 							 sizeof(u_int),
499 							 M_NOWAIT);
500 			if (mtag == NULL) {
501 				ifp->if_oerrors++;
502 				m_freem(m);
503 				continue;
504 			}
505 			VLAN_TAG_VALUE(mtag) = ifv->ifv_tag;
506 			m_tag_prepend(m, mtag);
507 			m->m_flags |= M_VLANTAG;
508 		} else {
509 			M_PREPEND(m, ifv->ifv_encaplen, M_DONTWAIT);
510 			if (m == NULL) {
511 				if_printf(ifp,
512 				    "unable to prepend VLAN header\n");
513 				ifp->if_oerrors++;
514 				continue;
515 			}
516 			/* M_PREPEND takes care of m_len, m_pkthdr.len for us */
517 
518 			if (m->m_len < sizeof(*evl)) {
519 				m = m_pullup(m, sizeof(*evl));
520 				if (m == NULL) {
521 					if_printf(ifp,
522 					    "cannot pullup VLAN header\n");
523 					ifp->if_oerrors++;
524 					continue;
525 				}
526 			}
527 
528 			/*
529 			 * Transform the Ethernet header into an Ethernet header
530 			 * with 802.1Q encapsulation.
531 			 */
532 			bcopy(mtod(m, char *) + ifv->ifv_encaplen,
533 			      mtod(m, char *), ETHER_HDR_LEN);
534 			evl = mtod(m, struct ether_vlan_header *);
535 			evl->evl_proto = evl->evl_encap_proto;
536 			evl->evl_encap_proto = htons(ETHERTYPE_VLAN);
537 			evl->evl_tag = htons(ifv->ifv_tag);
538 #ifdef DEBUG
539 			printf("%s: %*D\n", __func__, (int)sizeof(*evl),
540 			    (unsigned char *)evl, ":");
541 #endif
542 		}
543 
544 		/*
545 		 * Send it, precisely as ether_output() would have.
546 		 * We are already running at splimp.
547 		 */
548 		IFQ_HANDOFF(p, m, error);
549 		if (!error)
550 			ifp->if_opackets++;
551 		else
552 			ifp->if_oerrors++;
553 	}
554 	ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
555 }
556 
557 static void
558 vlan_input(struct ifnet *ifp, struct mbuf *m)
559 {
560 	struct ether_vlan_header *evl;
561 	struct ifvlan *ifv;
562 	struct m_tag *mtag;
563 	u_int tag;
564 
565 	if (m->m_flags & M_VLANTAG) {
566 		/*
567 		 * Packet is tagged, but m contains a normal
568 		 * Ethernet frame; the tag is stored out-of-band.
569 		 */
570 		mtag = m_tag_locate(m, MTAG_VLAN, MTAG_VLAN_TAG, NULL);
571 		KASSERT(mtag != NULL,
572 			("%s: M_VLANTAG without m_tag", __func__));
573 		tag = EVL_VLANOFTAG(VLAN_TAG_VALUE(mtag));
574 		m_tag_delete(m, mtag);
575 		m->m_flags &= ~M_VLANTAG;
576 	} else {
577 		/*
578 		 * Packet is tagged in-band as specified by 802.1q.
579 		 */
580 		mtag = NULL;
581 		switch (ifp->if_type) {
582 		case IFT_ETHER:
583 			if (m->m_len < sizeof(*evl) &&
584 			    (m = m_pullup(m, sizeof(*evl))) == NULL) {
585 				if_printf(ifp, "cannot pullup VLAN header\n");
586 				return;
587 			}
588 			evl = mtod(m, struct ether_vlan_header *);
589 			KASSERT(ntohs(evl->evl_encap_proto) == ETHERTYPE_VLAN,
590 				("%s: bad encapsulation protocol (%u)",
591 				 __func__, ntohs(evl->evl_encap_proto)));
592 
593 			tag = EVL_VLANOFTAG(ntohs(evl->evl_tag));
594 
595 			/*
596 			 * Restore the original ethertype.  We'll remove
597 			 * the encapsulation after we've found the vlan
598 			 * interface corresponding to the tag.
599 			 */
600 			evl->evl_encap_proto = evl->evl_proto;
601 			break;
602 		default:
603 			tag = (u_int) -1;
604 #ifdef INVARIANTS
605 			panic("%s: unsupported if_type (%u)",
606 			      __func__, ifp->if_type);
607 #endif
608 			break;
609 		}
610 	}
611 
612 	VLAN_LOCK();
613 	LIST_FOREACH(ifv, &ifv_list, ifv_list)
614 		if (ifp == ifv->ifv_p && tag == ifv->ifv_tag)
615 			break;
616 
617 	if (ifv == NULL || (ifv->ifv_ifp->if_flags & IFF_UP) == 0) {
618 		VLAN_UNLOCK();
619 		m_freem(m);
620 		ifp->if_noproto++;
621 #ifdef DEBUG
622 		printf("%s: tag %d, no interface\n", __func__, tag);
623 #endif
624 		return;
625 	}
626 	VLAN_UNLOCK();		/* XXX extend below? */
627 #ifdef DEBUG
628 	printf("%s: tag %d, parent %s\n", __func__, tag, ifv->ifv_p->if_xname);
629 #endif
630 
631 	if (mtag == NULL) {
632 		/*
633 		 * Packet had an in-line encapsulation header;
634 		 * remove it.  The original header has already
635 		 * been fixed up above.
636 		 */
637 		bcopy(mtod(m, caddr_t),
638 		      mtod(m, caddr_t) + ETHER_VLAN_ENCAP_LEN,
639 		      ETHER_HDR_LEN);
640 		m_adj(m, ETHER_VLAN_ENCAP_LEN);
641 	}
642 
643 	m->m_pkthdr.rcvif = ifv->ifv_ifp;
644 	ifv->ifv_ifp->if_ipackets++;
645 
646 	/* Pass it back through the parent's input routine. */
647 	(*ifp->if_input)(ifv->ifv_ifp, m);
648 }
649 
650 static int
651 vlan_config(struct ifvlan *ifv, struct ifnet *p)
652 {
653 	struct ifaddr *ifa1, *ifa2;
654 	struct sockaddr_dl *sdl1, *sdl2;
655 
656 	VLAN_LOCK_ASSERT();
657 
658 	if (p->if_data.ifi_type != IFT_ETHER)
659 		return (EPROTONOSUPPORT);
660 	if (ifv->ifv_p)
661 		return (EBUSY);
662 
663 	ifv->ifv_encaplen = ETHER_VLAN_ENCAP_LEN;
664 	ifv->ifv_mintu = ETHERMIN;
665 	ifv->ifv_flags = 0;
666 
667 	/*
668 	 * The active VLAN counter on the parent is used
669 	 * at various places to see if there is a vlan(4)
670 	 * attached to this physical interface.
671 	 */
672 	p->if_nvlans++;
673 
674 	/*
675 	 * If the parent supports the VLAN_MTU capability,
676 	 * i.e. can Tx/Rx larger than ETHER_MAX_LEN frames,
677 	 * use it.
678 	 */
679 	if (p->if_capenable & IFCAP_VLAN_MTU) {
680 		/*
681 		 * No need to fudge the MTU since the parent can
682 		 * handle extended frames.
683 		 */
684 		ifv->ifv_mtufudge = 0;
685 	} else {
686 		/*
687 		 * Fudge the MTU by the encapsulation size.  This
688 		 * makes us incompatible with strictly compliant
689 		 * 802.1Q implementations, but allows us to use
690 		 * the feature with other NetBSD implementations,
691 		 * which might still be useful.
692 		 */
693 		ifv->ifv_mtufudge = ifv->ifv_encaplen;
694 	}
695 
696 	ifv->ifv_p = p;
697 	ifv->ifv_ifp->if_mtu = p->if_mtu - ifv->ifv_mtufudge;
698 	/*
699 	 * Copy only a selected subset of flags from the parent.
700 	 * Other flags are none of our business.
701 	 */
702 	ifv->ifv_ifp->if_flags = (p->if_flags &
703 	    (IFF_BROADCAST | IFF_MULTICAST | IFF_SIMPLEX | IFF_POINTOPOINT));
704 	ifv->ifv_ifp->if_link_state = p->if_link_state;
705 
706 #if 0
707 	/*
708 	 * Not ready yet.  We need notification from the parent
709 	 * when hw checksumming flags in its if_capenable change.
710 	 * Flags set in if_capabilities only are useless.
711 	 */
712 	/*
713 	 * If the parent interface can do hardware-assisted
714 	 * VLAN encapsulation, then propagate its hardware-
715 	 * assisted checksumming flags.
716 	 */
717 	if (p->if_capabilities & IFCAP_VLAN_HWTAGGING)
718 		ifv->ifv_ifpif_capabilities |= p->if_capabilities & IFCAP_HWCSUM;
719 #endif
720 
721 	/*
722 	 * Set up our ``Ethernet address'' to reflect the underlying
723 	 * physical interface's.
724 	 */
725 	ifa1 = ifaddr_byindex(ifv->ifv_ifp->if_index);
726 	ifa2 = ifaddr_byindex(p->if_index);
727 	sdl1 = (struct sockaddr_dl *)ifa1->ifa_addr;
728 	sdl2 = (struct sockaddr_dl *)ifa2->ifa_addr;
729 	sdl1->sdl_type = IFT_ETHER;
730 	sdl1->sdl_alen = ETHER_ADDR_LEN;
731 	bcopy(LLADDR(sdl2), LLADDR(sdl1), ETHER_ADDR_LEN);
732 	bcopy(LLADDR(sdl2), IFP2ENADDR(ifv->ifv_ifp), ETHER_ADDR_LEN);
733 
734 	/*
735 	 * Configure multicast addresses that may already be
736 	 * joined on the vlan device.
737 	 */
738 	(void)vlan_setmulti(ifv->ifv_ifp); /* XXX: VLAN lock held */
739 
740 	return (0);
741 }
742 
743 static int
744 vlan_unconfig(struct ifnet *ifp)
745 {
746 	struct ifaddr *ifa;
747 	struct sockaddr_dl *sdl;
748 	struct vlan_mc_entry *mc;
749 	struct ifvlan *ifv;
750 	struct ifnet *p;
751 	int error;
752 
753 	VLAN_LOCK_ASSERT();
754 
755 	ifv = ifp->if_softc;
756 	p = ifv->ifv_p;
757 
758 	if (p) {
759 		struct sockaddr_dl sdl;
760 
761 		/*
762 		 * Since the interface is being unconfigured, we need to
763 		 * empty the list of multicast groups that we may have joined
764 		 * while we were alive from the parent's list.
765 		 */
766 		bzero((char *)&sdl, sizeof(sdl));
767 		sdl.sdl_len = sizeof(sdl);
768 		sdl.sdl_family = AF_LINK;
769 		sdl.sdl_index = p->if_index;
770 		sdl.sdl_type = IFT_ETHER;
771 		sdl.sdl_alen = ETHER_ADDR_LEN;
772 
773 		while(SLIST_FIRST(&ifv->vlan_mc_listhead) != NULL) {
774 			mc = SLIST_FIRST(&ifv->vlan_mc_listhead);
775 			bcopy((char *)&mc->mc_addr, LLADDR(&sdl),
776 			    ETHER_ADDR_LEN);
777 			error = if_delmulti(p, (struct sockaddr *)&sdl);
778 			if (error)
779 				return (error);
780 			SLIST_REMOVE_HEAD(&ifv->vlan_mc_listhead, mc_entries);
781 			free(mc, M_VLAN);
782 		}
783 
784 		p->if_nvlans--;
785 	}
786 
787 	/* Disconnect from parent. */
788 	ifv->ifv_p = NULL;
789 	ifv->ifv_ifp->if_mtu = ETHERMTU;		/* XXX why not 0? */
790 	ifv->ifv_flags = 0;
791 	ifv->ifv_ifp->if_link_state = LINK_STATE_UNKNOWN;
792 
793 	/* Clear our MAC address. */
794 	ifa = ifaddr_byindex(ifv->ifv_ifp->if_index);
795 	sdl = (struct sockaddr_dl *)ifa->ifa_addr;
796 	sdl->sdl_type = IFT_ETHER;
797 	sdl->sdl_alen = ETHER_ADDR_LEN;
798 	bzero(LLADDR(sdl), ETHER_ADDR_LEN);
799 	bzero(IFP2ENADDR(ifv->ifv_ifp), ETHER_ADDR_LEN);
800 
801 	return (0);
802 }
803 
804 static int
805 vlan_set_promisc(struct ifnet *ifp)
806 {
807 	struct ifvlan *ifv = ifp->if_softc;
808 	int error = 0;
809 
810 	if ((ifp->if_flags & IFF_PROMISC) != 0) {
811 		if ((ifv->ifv_flags & IFVF_PROMISC) == 0) {
812 			error = ifpromisc(ifv->ifv_p, 1);
813 			if (error == 0)
814 				ifv->ifv_flags |= IFVF_PROMISC;
815 		}
816 	} else {
817 		if ((ifv->ifv_flags & IFVF_PROMISC) != 0) {
818 			error = ifpromisc(ifv->ifv_p, 0);
819 			if (error == 0)
820 				ifv->ifv_flags &= ~IFVF_PROMISC;
821 		}
822 	}
823 
824 	return (error);
825 }
826 
827 /* Inform all vlans that their parent has changed link state */
828 static void
829 vlan_link_state(struct ifnet *ifp, int link)
830 {
831 	struct ifvlan *ifv;
832 
833 	VLAN_LOCK();
834 	LIST_FOREACH(ifv, &ifv_list, ifv_list) {
835 		if (ifv->ifv_p == ifp)
836 			if_link_state_change(ifv->ifv_ifp,
837 			    ifv->ifv_p->if_link_state);
838 	}
839 	VLAN_UNLOCK();
840 }
841 
842 static int
843 vlan_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
844 {
845 	struct ifaddr *ifa;
846 	struct ifnet *p;
847 	struct ifreq *ifr;
848 	struct ifvlan *ifv;
849 	struct vlanreq vlr;
850 	int error = 0;
851 
852 	ifr = (struct ifreq *)data;
853 	ifa = (struct ifaddr *)data;
854 	ifv = ifp->if_softc;
855 
856 	switch (cmd) {
857 	case SIOCSIFADDR:
858 		ifp->if_flags |= IFF_UP;
859 
860 		switch (ifa->ifa_addr->sa_family) {
861 #ifdef INET
862 		case AF_INET:
863 			arp_ifinit(ifv->ifv_ifp, ifa);
864 			break;
865 #endif
866 		default:
867 			break;
868 		}
869 		break;
870 
871 	case SIOCGIFADDR:
872 		{
873 			struct sockaddr *sa;
874 
875 			sa = (struct sockaddr *) &ifr->ifr_data;
876 			bcopy(IFP2ENADDR(ifp), (caddr_t)sa->sa_data,
877 			    ETHER_ADDR_LEN);
878 		}
879 		break;
880 
881 	case SIOCGIFMEDIA:
882 		VLAN_LOCK();
883 		if (ifv->ifv_p != NULL) {
884 			error = (*ifv->ifv_p->if_ioctl)(ifv->ifv_p,
885 					SIOCGIFMEDIA, data);
886 			VLAN_UNLOCK();
887 			/* Limit the result to the parent's current config. */
888 			if (error == 0) {
889 				struct ifmediareq *ifmr;
890 
891 				ifmr = (struct ifmediareq *)data;
892 				if (ifmr->ifm_count >= 1 && ifmr->ifm_ulist) {
893 					ifmr->ifm_count = 1;
894 					error = copyout(&ifmr->ifm_current,
895 						ifmr->ifm_ulist,
896 						sizeof(int));
897 				}
898 			}
899 		} else {
900 			VLAN_UNLOCK();
901 			error = EINVAL;
902 		}
903 		break;
904 
905 	case SIOCSIFMEDIA:
906 		error = EINVAL;
907 		break;
908 
909 	case SIOCSIFMTU:
910 		/*
911 		 * Set the interface MTU.
912 		 */
913 		VLAN_LOCK();
914 		if (ifv->ifv_p != NULL) {
915 			if (ifr->ifr_mtu >
916 			     (ifv->ifv_p->if_mtu - ifv->ifv_mtufudge) ||
917 			    ifr->ifr_mtu <
918 			     (ifv->ifv_mintu - ifv->ifv_mtufudge))
919 				error = EINVAL;
920 			else
921 				ifp->if_mtu = ifr->ifr_mtu;
922 		} else
923 			error = EINVAL;
924 		VLAN_UNLOCK();
925 		break;
926 
927 	case SIOCSETVLAN:
928 		error = copyin(ifr->ifr_data, &vlr, sizeof(vlr));
929 		if (error)
930 			break;
931 		if (vlr.vlr_parent[0] == '\0') {
932 			VLAN_LOCK();
933 			vlan_unconfig(ifp);
934 			if (ifp->if_flags & IFF_UP)
935 				if_down(ifp);
936 			ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
937 			VLAN_UNLOCK();
938 			break;
939 		}
940 		p = ifunit(vlr.vlr_parent);
941 		if (p == 0) {
942 			error = ENOENT;
943 			break;
944 		}
945 		/*
946 		 * Don't let the caller set up a VLAN tag with
947 		 * anything except VLID bits.
948 		 */
949 		if (vlr.vlr_tag & ~EVL_VLID_MASK) {
950 			error = EINVAL;
951 			break;
952 		}
953 		VLAN_LOCK();
954 		error = vlan_config(ifv, p);
955 		if (error) {
956 			VLAN_UNLOCK();
957 			break;
958 		}
959 		ifv->ifv_tag = vlr.vlr_tag;
960 		ifp->if_drv_flags |= IFF_DRV_RUNNING;
961 		VLAN_UNLOCK();
962 
963 		/* Update promiscuous mode, if necessary. */
964 		vlan_set_promisc(ifp);
965 		break;
966 
967 	case SIOCGETVLAN:
968 		bzero(&vlr, sizeof(vlr));
969 		VLAN_LOCK();
970 		if (ifv->ifv_p) {
971 			strlcpy(vlr.vlr_parent, ifv->ifv_p->if_xname,
972 			    sizeof(vlr.vlr_parent));
973 			vlr.vlr_tag = ifv->ifv_tag;
974 		}
975 		VLAN_UNLOCK();
976 		error = copyout(&vlr, ifr->ifr_data, sizeof(vlr));
977 		break;
978 
979 	case SIOCSIFFLAGS:
980 		/*
981 		 * For promiscuous mode, we enable promiscuous mode on
982 		 * the parent if we need promiscuous on the VLAN interface.
983 		 */
984 		if (ifv->ifv_p != NULL)
985 			error = vlan_set_promisc(ifp);
986 		break;
987 
988 	case SIOCADDMULTI:
989 	case SIOCDELMULTI:
990 		/*VLAN_LOCK();*/
991 		error = vlan_setmulti(ifp);
992 		/*VLAN_UNLOCK();*/
993 		break;
994 	default:
995 		error = EINVAL;
996 	}
997 
998 	return (error);
999 }
1000