2 * Copyright 1998 Massachusetts Institute of Technology
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
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
29 * $FreeBSD: src/sys/net/if_vlan.c,v 1.15.2.13 2003/02/14 22:25:58 fenner Exp $
30 * $DragonFly: src/sys/net/vlan/if_vlan.c,v 1.21 2006/09/05 00:55:48 dillon Exp $
34 * if_vlan.c - pseudo-device driver for IEEE 802.1Q virtual LANs.
35 * Might be extended some day to also handle IEEE 802.1p priority
36 * tagging. This is sort of sneaky in the implementation, since
37 * we need to pretend to be enough of an Ethernet implementation
38 * to make arp work. The way we do this is by telling everyone
39 * that we are an Ethernet, and then catch the packets that
40 * ether_output() left on our output queue queue when it calls
41 * if_start(), rewrite them for use by the real outgoing interface,
42 * and ask it to send them.
45 * XXX It's incorrect to assume that we must always kludge up
46 * headers on the physical device's behalf: some devices support
47 * VLAN tag insertion and extraction in firmware. For these cases,
48 * one can change the behavior of the vlan interface by setting
49 * the LINK0 flag on it (that is setting the vlan interface's LINK0
50 * flag, _not_ the parent's LINK0 flag; we try to leave the parent
51 * alone). If the interface has the LINK0 flag set, then it will
52 * not modify the ethernet header on output, because the parent
53 * can do that for itself. On input, the parent can call vlan_input_tag()
54 * directly in order to supply us with an incoming mbuf and the vlan
55 * tag value that goes with it.
63 #include <sys/param.h>
64 #include <sys/kernel.h>
65 #include <sys/malloc.h>
67 #include <sys/module.h>
68 #include <sys/queue.h>
69 #include <sys/socket.h>
70 #include <sys/sockio.h>
71 #include <sys/sysctl.h>
72 #include <sys/systm.h>
73 #include <sys/thread2.h>
74 #include <machine/bus.h> /* XXX: Shouldn't really be required! */
77 #include <net/ethernet.h>
79 #include <net/if_arp.h>
80 #include <net/if_dl.h>
81 #include <net/if_types.h>
82 #include <net/ifq_var.h>
83 #include "if_vlan_var.h"
86 #include <netinet/in.h>
87 #include <netinet/if_ether.h>
90 #define VLANNAME "vlan"
92 SYSCTL_DECL(_net_link);
93 SYSCTL_NODE(_net_link, IFT_L2VLAN, vlan, CTLFLAG_RW, 0, "IEEE 802.1Q VLAN");
94 SYSCTL_NODE(_net_link_vlan, PF_LINK, link, CTLFLAG_RW, 0, "for consistency");
96 static MALLOC_DEFINE(M_VLAN, "vlan", "802.1Q Virtual LAN Interface");
97 static LIST_HEAD(, ifvlan) ifv_list;
99 static int vlan_clone_create(struct if_clone *, int);
100 static void vlan_clone_destroy(struct ifnet *);
101 static void vlan_start(struct ifnet *ifp);
102 static void vlan_ifinit(void *foo);
103 static int vlan_input(struct ether_header *eh, struct mbuf *m);
104 static int vlan_input_tag(struct mbuf *m, uint16_t t);
105 static int vlan_ioctl(struct ifnet *ifp, u_long cmd, caddr_t addr,
107 static int vlan_setmulti(struct ifnet *ifp);
108 static int vlan_unconfig(struct ifnet *ifp);
109 static int vlan_config(struct ifvlan *ifv, struct ifnet *p);
111 struct if_clone vlan_cloner = IF_CLONE_INITIALIZER("vlan", vlan_clone_create,
112 vlan_clone_destroy, NVLAN, IF_MAXUNIT);
115 * Program our multicast filter. What we're actually doing is
116 * programming the multicast filter of the parent. This has the
117 * side effect of causing the parent interface to receive multicast
118 * traffic that it doesn't really want, which ends up being discarded
119 * later by the upper protocol layers. Unfortunately, there's no way
120 * to avoid this: there really is only one physical interface.
123 vlan_setmulti(struct ifnet *ifp)
126 struct ifmultiaddr *ifma, *rifma = NULL;
128 struct vlan_mc_entry *mc = NULL;
129 struct sockaddr_dl sdl;
132 /* Find the parent. */
137 * If we don't have a parent, just remember the membership for
143 bzero((char *)&sdl, sizeof sdl);
144 sdl.sdl_len = sizeof sdl;
145 sdl.sdl_family = AF_LINK;
146 sdl.sdl_index = ifp_p->if_index;
147 sdl.sdl_type = IFT_ETHER;
148 sdl.sdl_alen = ETHER_ADDR_LEN;
150 /* First, remove any existing filter entries. */
151 while(SLIST_FIRST(&sc->vlan_mc_listhead) != NULL) {
152 mc = SLIST_FIRST(&sc->vlan_mc_listhead);
153 bcopy((char *)&mc->mc_addr, LLADDR(&sdl), ETHER_ADDR_LEN);
154 error = if_delmulti(ifp_p, (struct sockaddr *)&sdl);
157 SLIST_REMOVE_HEAD(&sc->vlan_mc_listhead, mc_entries);
161 /* Now program new ones. */
162 LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
163 if (ifma->ifma_addr->sa_family != AF_LINK)
165 mc = kmalloc(sizeof(struct vlan_mc_entry), M_VLAN, M_WAITOK);
166 bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
167 (char *)&mc->mc_addr, ETHER_ADDR_LEN);
168 SLIST_INSERT_HEAD(&sc->vlan_mc_listhead, mc, mc_entries);
169 bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
170 LLADDR(&sdl), ETHER_ADDR_LEN);
171 error = if_addmulti(ifp_p, (struct sockaddr *)&sdl, &rifma);
180 vlan_modevent(module_t mod, int type, void *data)
185 LIST_INIT(&ifv_list);
186 vlan_input_p = vlan_input;
187 vlan_input_tag_p = vlan_input_tag;
188 if_clone_attach(&vlan_cloner);
191 if_clone_detach(&vlan_cloner);
193 vlan_input_tag_p = NULL;
194 while (!LIST_EMPTY(&ifv_list))
195 vlan_clone_destroy(&LIST_FIRST(&ifv_list)->ifv_if);
201 static moduledata_t vlan_mod = {
207 DECLARE_MODULE(if_vlan, vlan_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
210 vlan_clone_create(struct if_clone *ifc, int unit)
215 ifv = kmalloc(sizeof(struct ifvlan), M_VLAN, M_WAITOK | M_ZERO);
217 SLIST_INIT(&ifv->vlan_mc_listhead);
220 LIST_INSERT_HEAD(&ifv_list, ifv, ifv_list);
224 if_initname(ifp, "vlan", unit);
225 /* NB: flags are not set here */
226 ifp->if_linkmib = &ifv->ifv_mib;
227 ifp->if_linkmiblen = sizeof ifv->ifv_mib;
228 /* NB: mtu is not set here */
230 ifp->if_init = vlan_ifinit;
231 ifp->if_start = vlan_start;
232 ifp->if_ioctl = vlan_ioctl;
233 ifq_set_maxlen(&ifp->if_snd, ifqmaxlen);
234 ifq_set_ready(&ifp->if_snd);
235 ether_ifattach(ifp, ifv->ifv_ac.ac_enaddr, NULL);
236 /* Now undo some of the damage... */
237 ifp->if_data.ifi_type = IFT_L2VLAN;
238 ifp->if_data.ifi_hdrlen = EVL_ENCAPLEN;
244 vlan_clone_destroy(struct ifnet *ifp)
246 struct ifvlan *ifv = ifp->if_softc;
250 LIST_REMOVE(ifv, ifv_list);
260 vlan_ifinit(void *foo)
266 vlan_start(struct ifnet *ifp)
270 struct ether_vlan_header *evl;
273 struct altq_pktattr pktattr;
278 ifp->if_flags |= IFF_OACTIVE;
280 m = ifq_dequeue(&ifp->if_snd, NULL);
286 * Do not run parent's if_start() if the parent is not up,
287 * or parent's driver will cause a system crash.
289 if ((p->if_flags & (IFF_UP | IFF_RUNNING)) !=
290 (IFF_UP | IFF_RUNNING)) {
292 ifp->if_data.ifi_collisions++;
297 * If ALTQ is enabled on the parent interface, do
298 * classification; the queueing discipline might
299 * not require classification, but might require
300 * the address family/header pointer in the pktattr.
302 if (ifq_is_enabled(&p->if_snd))
303 altq_etherclassify(&p->if_snd, m, &pktattr);
306 * If underlying interface can do VLAN tag insertion itself,
307 * just pass the packet along. However, we need some way to
308 * tell the interface where the packet came from so that it
309 * knows how to find the VLAN tag to use, so we set the rcvif
310 * in the mbuf header to our ifnet.
312 * Note: we also set the M_PROTO1 flag in the mbuf to let
313 * the parent driver know that the rcvif pointer is really
314 * valid. We need to do this because sometimes mbufs will
315 * be allocated by other parts of the system that contain
316 * garbage in the rcvif pointer. Using the M_PROTO1 flag
317 * lets the driver perform a proper sanity check and avoid
318 * following potentially bogus rcvif pointers off into
321 if (p->if_capenable & IFCAP_VLAN_HWTAGGING) {
322 m->m_pkthdr.rcvif = ifp;
323 m->m_flags |= M_PROTO1;
325 M_PREPEND(m, EVL_ENCAPLEN, MB_DONTWAIT);
327 printf("%s: M_PREPEND failed", ifp->if_xname);
331 /* M_PREPEND takes care of m_len, m_pkthdr.len for us */
333 m = m_pullup(m, ETHER_HDR_LEN + EVL_ENCAPLEN);
335 printf("%s: m_pullup failed", ifp->if_xname);
341 * Transform the Ethernet header into an Ethernet header
342 * with 802.1Q encapsulation.
344 bcopy(mtod(m, char *) + EVL_ENCAPLEN, mtod(m, char *),
345 sizeof(struct ether_header));
346 evl = mtod(m, struct ether_vlan_header *);
347 evl->evl_proto = evl->evl_encap_proto;
348 evl->evl_encap_proto = htons(ETHERTYPE_VLAN);
349 evl->evl_tag = htons(ifv->ifv_tag);
351 printf("vlan_start: %*D\n", sizeof *evl,
352 (unsigned char *)evl, ":");
357 * Send it, precisely as ether_output() would have.
358 * We are already running at splimp.
360 lwkt_serialize_exit(ifp->if_serializer);
361 lwkt_serialize_enter(p->if_serializer);
362 error = ifq_handoff(p, m, &pktattr);
363 lwkt_serialize_exit(p->if_serializer);
364 lwkt_serialize_enter(ifp->if_serializer);
370 ifp->if_flags &= ~IFF_OACTIVE;
376 vlan_input_tag( struct mbuf *m, uint16_t t)
382 rcvif = m->m_pkthdr.rcvif;
384 ASSERT_SERIALIZED(rcvif->if_serializer);
387 * Fake up a header and send the packet to the physical interface's
390 if ((bif = rcvif->if_bpf) != NULL) {
391 struct ether_header *eh;
392 struct ether_vlan_header evh;
394 eh = mtod(m, struct ether_header *);
395 m_adj(m, ETHER_HDR_LEN);
396 bcopy(eh, &evh, 2*ETHER_ADDR_LEN);
397 evh.evl_encap_proto = htons(ETHERTYPE_VLAN);
398 evh.evl_tag = htons(t);
399 evh.evl_proto = eh->ether_type;
400 bpf_ptap(bif, m, &evh, ETHER_HDR_LEN + EVL_ENCAPLEN);
401 /* XXX assumes data was left intact */
402 M_PREPEND(m, ETHER_HDR_LEN, MB_WAIT);
405 for (ifv = LIST_FIRST(&ifv_list); ifv != NULL;
406 ifv = LIST_NEXT(ifv, ifv_list)) {
407 if (rcvif == ifv->ifv_p && ifv->ifv_tag == t)
411 if (ifv == NULL || (ifv->ifv_if.if_flags & IFF_UP) == 0) {
413 return -1; /* So the parent can take note */
417 * Having found a valid vlan interface corresponding to
418 * the given source interface and vlan tag, run the
419 * the real packet through ether_input().
421 m->m_pkthdr.rcvif = &ifv->ifv_if;
423 ifv->ifv_if.if_ipackets++;
424 lwkt_serialize_exit(rcvif->if_serializer);
425 lwkt_serialize_enter(ifv->ifv_if.if_serializer);
426 ether_input(&ifv->ifv_if, NULL, m);
427 lwkt_serialize_exit(ifv->ifv_if.if_serializer);
428 lwkt_serialize_enter(rcvif->if_serializer);
433 vlan_input(struct ether_header *eh, struct mbuf *m)
437 struct ether_header eh_copy;
439 rcvif = m->m_pkthdr.rcvif;
440 ASSERT_SERIALIZED(rcvif->if_serializer);
442 for (ifv = LIST_FIRST(&ifv_list); ifv != NULL;
443 ifv = LIST_NEXT(ifv, ifv_list)) {
444 if (rcvif == ifv->ifv_p
445 && (EVL_VLANOFTAG(ntohs(*mtod(m, u_int16_t *)))
450 if (ifv == NULL || (ifv->ifv_if.if_flags & IFF_UP) == 0) {
453 return -1; /* so ether_input can take note */
457 * Having found a valid vlan interface corresponding to
458 * the given source interface and vlan tag, remove the
459 * remaining encapsulation (ether_vlan_header minus the ether_header
460 * that had already been removed) and run the real packet
461 * through ether_input() a second time (it had better be
465 eh_copy.ether_type = mtod(m, u_int16_t *)[1]; /* evl_proto */
466 m->m_pkthdr.rcvif = &ifv->ifv_if;
467 m_adj(m, EVL_ENCAPLEN);
468 M_PREPEND(m, ETHER_HDR_LEN, MB_WAIT);
469 *(struct ether_header *)mtod(m, void *) = eh_copy;
471 ifv->ifv_if.if_ipackets++;
472 lwkt_serialize_exit(rcvif->if_serializer);
473 lwkt_serialize_enter(ifv->ifv_if.if_serializer);
474 ether_input(&ifv->ifv_if, NULL, m);
475 lwkt_serialize_exit(ifv->ifv_if.if_serializer);
476 lwkt_serialize_enter(rcvif->if_serializer);
481 vlan_config(struct ifvlan *ifv, struct ifnet *p)
483 struct sockaddr_dl *sdl1, *sdl2;
485 if (p->if_data.ifi_type != IFT_ETHER)
486 return EPROTONOSUPPORT;
490 if (p->if_capenable & IFCAP_VLAN_MTU)
491 ifv->ifv_if.if_mtu = p->if_mtu;
493 ifv->ifv_if.if_mtu = p->if_data.ifi_mtu - EVL_ENCAPLEN;
496 * Copy only a selected subset of flags from the parent.
497 * Other flags are none of our business.
499 ifv->ifv_if.if_flags = (p->if_flags &
500 (IFF_BROADCAST | IFF_MULTICAST | IFF_SIMPLEX | IFF_POINTOPOINT));
503 * Set up our ``Ethernet address'' to reflect the underlying
504 * physical interface's.
506 sdl1 = IF_LLSOCKADDR(&ifv->ifv_if);
507 sdl2 = IF_LLSOCKADDR(p);
508 sdl1->sdl_type = IFT_ETHER;
509 sdl1->sdl_alen = ETHER_ADDR_LEN;
510 bcopy(LLADDR(sdl2), LLADDR(sdl1), ETHER_ADDR_LEN);
511 bcopy(LLADDR(sdl2), ifv->ifv_ac.ac_enaddr, ETHER_ADDR_LEN);
514 * Configure multicast addresses that may already be
515 * joined on the vlan device.
517 vlan_setmulti(&ifv->ifv_if);
523 vlan_unconfig(struct ifnet *ifp)
525 struct sockaddr_dl *sdl;
526 struct vlan_mc_entry *mc;
535 struct sockaddr_dl sdl;
538 * Since the interface is being unconfigured, we need to
539 * empty the list of multicast groups that we may have joined
540 * while we were alive from the parent's list.
542 bzero((char *)&sdl, sizeof sdl);
543 sdl.sdl_len = sizeof sdl;
544 sdl.sdl_family = AF_LINK;
545 sdl.sdl_index = p->if_index;
546 sdl.sdl_type = IFT_ETHER;
547 sdl.sdl_alen = ETHER_ADDR_LEN;
549 while(SLIST_FIRST(&ifv->vlan_mc_listhead) != NULL) {
550 mc = SLIST_FIRST(&ifv->vlan_mc_listhead);
551 bcopy((char *)&mc->mc_addr, LLADDR(&sdl), ETHER_ADDR_LEN);
552 error = if_delmulti(p, (struct sockaddr *)&sdl);
555 SLIST_REMOVE_HEAD(&ifv->vlan_mc_listhead, mc_entries);
560 /* Disconnect from parent. */
562 ifv->ifv_if.if_mtu = ETHERMTU;
564 /* Clear our MAC address. */
565 sdl = IF_LLSOCKADDR(&ifv->ifv_if);
566 sdl->sdl_type = IFT_ETHER;
567 sdl->sdl_alen = ETHER_ADDR_LEN;
568 bzero(LLADDR(sdl), ETHER_ADDR_LEN);
569 bzero(ifv->ifv_ac.ac_enaddr, ETHER_ADDR_LEN);
575 vlan_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
584 ifr = (struct ifreq *)data;
585 ifa = (struct ifaddr *)data;
588 ASSERT_SERIALIZED(ifp->if_serializer);
593 ifp->if_flags |= IFF_UP;
595 switch (ifa->ifa_addr->sa_family) {
598 arp_ifinit(&ifv->ifv_if, ifa);
610 sa = (struct sockaddr *) &ifr->ifr_data;
611 bcopy(((struct arpcom *)ifp->if_softc)->ac_enaddr,
612 (caddr_t) sa->sa_data, ETHER_ADDR_LEN);
617 if (ifv->ifv_p != NULL) {
618 lwkt_serialize_exit(ifp->if_serializer);
619 lwkt_serialize_enter(ifv->ifv_p->if_serializer);
620 error = ifv->ifv_p->if_ioctl(ifv->ifv_p,
621 SIOCGIFMEDIA, data, cr);
622 lwkt_serialize_exit(ifv->ifv_p->if_serializer);
623 lwkt_serialize_enter(ifp->if_serializer);
624 /* Limit the result to the parent's current config. */
626 struct ifmediareq *ifmr;
628 ifmr = (struct ifmediareq *) data;
629 if (ifmr->ifm_count >= 1 && ifmr->ifm_ulist) {
631 error = copyout(&ifmr->ifm_current,
646 * Set the interface MTU.
647 * This is bogus. The underlying interface might support
650 if (ifr->ifr_mtu > ETHERMTU) {
653 ifp->if_mtu = ifr->ifr_mtu;
658 error = copyin(ifr->ifr_data, &vlr, sizeof vlr);
661 if (vlr.vlr_parent[0] == '\0') {
663 if (ifp->if_flags & IFF_UP)
665 ifp->if_flags &= ~IFF_RUNNING;
668 p = ifunit(vlr.vlr_parent);
673 error = vlan_config(ifv, p);
676 ifv->ifv_tag = vlr.vlr_tag;
677 ifp->if_flags |= IFF_RUNNING;
681 bzero(&vlr, sizeof vlr);
683 strlcpy(vlr.vlr_parent, ifv->ifv_p->if_xname,
684 sizeof(vlr.vlr_parent));
685 vlr.vlr_tag = ifv->ifv_tag;
687 error = copyout(&vlr, ifr->ifr_data, sizeof vlr);
692 * We don't support promiscuous mode
693 * right now because it would require help from the
694 * underlying drivers, which hasn't been implemented.
696 if (ifr->ifr_flags & (IFF_PROMISC)) {
697 ifp->if_flags &= ~(IFF_PROMISC);
703 error = vlan_setmulti(ifp);