2 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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. Neither the name of the project nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $FreeBSD: src/sys/net/if_gif.c,v 1.4.2.15 2002/11/08 16:57:13 ume Exp $
30 * $DragonFly: src/sys/net/gif/if_gif.c,v 1.21 2008/05/14 11:59:23 sephe Exp $
31 * $KAME: if_gif.c,v 1.87 2001/10/19 08:50:27 itojun Exp $
35 #include "opt_inet6.h"
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/malloc.h>
43 #include <sys/socket.h>
44 #include <sys/sockio.h>
45 #include <sys/errno.h>
47 #include <sys/sysctl.h>
48 #include <sys/syslog.h>
49 #include <sys/protosw.h>
51 #include <sys/thread2.h>
53 #include <machine/cpu.h>
56 #include <net/if_types.h>
57 #include <net/netisr.h>
58 #include <net/route.h>
60 #include <net/if_clone.h>
62 #include <netinet/in.h>
63 #include <netinet/in_systm.h>
64 #include <netinet/ip.h>
66 #include <netinet/in_var.h>
67 #include <netinet/in_gif.h>
68 #include <netinet/ip_var.h>
73 #include <netinet/in.h>
75 #include <netinet6/in6_var.h>
76 #include <netinet/ip6.h>
77 #include <netinet6/ip6_var.h>
78 #include <netinet6/in6_gif.h>
79 #include <netinet6/ip6protosw.h>
82 #include <netinet/ip_encap.h>
85 #include <net/net_osdep.h>
89 static MALLOC_DEFINE(M_GIF, "gif", "Generic Tunnel Interface");
90 LIST_HEAD(, gif_softc) gif_softc_list;
92 int gif_clone_create (struct if_clone *, int, caddr_t);
93 void gif_clone_destroy (struct ifnet *);
95 struct if_clone gif_cloner = IF_CLONE_INITIALIZER("gif", gif_clone_create,
96 gif_clone_destroy, 0, IF_MAXUNIT);
98 static int gifmodevent (module_t, int, void *);
100 SYSCTL_DECL(_net_link);
101 SYSCTL_NODE(_net_link, IFT_GIF, gif, CTLFLAG_RW, 0,
102 "Generic Tunnel Interface");
105 * This macro controls the default upper limitation on nesting of gif tunnels.
106 * Since, setting a large value to this macro with a careless configuration
107 * may introduce system crash, we don't allow any nestings by default.
108 * If you need to configure nested gif tunnels, you can define this macro
109 * in your kernel configuration file. However, if you do so, please be
110 * careful to configure the tunnels so that it won't make a loop.
112 #define MAX_GIF_NEST 1
114 static int max_gif_nesting = MAX_GIF_NEST;
115 SYSCTL_INT(_net_link_gif, OID_AUTO, max_nesting, CTLFLAG_RW,
116 &max_gif_nesting, 0, "Max nested tunnels");
119 * By default, we disallow creation of multiple tunnels between the same
120 * pair of addresses. Some applications require this functionality so
121 * we allow control over this check here.
124 static int parallel_tunnels = 1;
126 static int parallel_tunnels = 0;
128 SYSCTL_INT(_net_link_gif, OID_AUTO, parallel_tunnels, CTLFLAG_RW,
129 ¶llel_tunnels, 0, "Allow parallel tunnels?");
132 gif_clone_create(struct if_clone *ifc, int unit, caddr_t params)
134 struct gif_softc *sc;
136 sc = kmalloc (sizeof(struct gif_softc), M_GIF, M_WAITOK | M_ZERO);
138 sc->gif_if.if_softc = sc;
139 if_initname(&(sc->gif_if), GIFNAME, unit);
143 LIST_INSERT_HEAD(&gif_softc_list, sc, gif_list);
148 gifattach0(struct gif_softc *sc)
151 sc->encap_cookie4 = sc->encap_cookie6 = NULL;
153 sc->gif_if.if_addrlen = 0;
154 sc->gif_if.if_mtu = GIF_MTU;
155 sc->gif_if.if_flags = IFF_POINTOPOINT | IFF_MULTICAST;
157 /* turn off ingress filter */
158 sc->gif_if.if_flags |= IFF_LINK2;
160 sc->gif_if.if_ioctl = gif_ioctl;
161 sc->gif_if.if_output = gif_output;
162 sc->gif_if.if_type = IFT_GIF;
163 sc->gif_if.if_snd.ifq_maxlen = IFQ_MAXLEN;
164 if_attach(&sc->gif_if, NULL);
165 bpfattach(&sc->gif_if, DLT_NULL, sizeof(u_int));
169 gif_clone_destroy(struct ifnet *ifp)
172 struct gif_softc *sc = ifp->if_softc;
174 gif_delete_tunnel(&sc->gif_if);
175 LIST_REMOVE(sc, gif_list);
177 if (sc->encap_cookie6 != NULL) {
178 err = encap_detach(sc->encap_cookie6);
179 KASSERT(err == 0, ("Unexpected error detaching encap_cookie6"));
183 if (sc->encap_cookie4 != NULL) {
184 err = encap_detach(sc->encap_cookie4);
185 KASSERT(err == 0, ("Unexpected error detaching encap_cookie4"));
196 gifmodevent(module_t mod, int type, void *data)
201 LIST_INIT(&gif_softc_list);
202 if_clone_attach(&gif_cloner);
205 ip6_gif_hlim = GIF_HLIM;
210 if_clone_detach(&gif_cloner);
212 while (!LIST_EMPTY(&gif_softc_list))
213 gif_clone_destroy(&LIST_FIRST(&gif_softc_list)->gif_if);
223 static moduledata_t gif_mod = {
229 DECLARE_MODULE(if_gif, gif_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
232 gif_encapcheck(const struct mbuf *m, int off, int proto, void *arg)
235 struct gif_softc *sc;
237 sc = (struct gif_softc *)arg;
241 if ((sc->gif_if.if_flags & IFF_UP) == 0)
244 /* no physical address */
245 if (!sc->gif_psrc || !sc->gif_pdst)
261 /* Bail on short packets */
262 if (m->m_pkthdr.len < sizeof(ip))
265 m_copydata(m, 0, sizeof(ip), (caddr_t)&ip);
270 if (sc->gif_psrc->sa_family != AF_INET ||
271 sc->gif_pdst->sa_family != AF_INET)
273 return gif_encapcheck4(m, off, proto, arg);
277 if (m->m_pkthdr.len < sizeof(struct ip6_hdr))
279 if (sc->gif_psrc->sa_family != AF_INET6 ||
280 sc->gif_pdst->sa_family != AF_INET6)
282 return gif_encapcheck6(m, off, proto, arg);
294 gif_output_serialized(struct ifnet *ifp, struct mbuf *m, struct sockaddr *dst,
297 struct gif_softc *sc = (struct gif_softc*)ifp;
299 static int called = 0; /* XXX: MUTEX */
302 * gif may cause infinite recursion calls when misconfigured.
303 * We'll prevent this by introducing upper limit.
304 * XXX: this mechanism may introduce another problem about
305 * mutual exclusion of the variable CALLED, especially if we
308 if (++called > max_gif_nesting) {
310 "gif_output: recursively called too many times(%d)\n",
313 error = EIO; /* is there better errno? */
317 m->m_flags &= ~(M_BCAST|M_MCAST);
318 if (!(ifp->if_flags & IFF_UP) ||
319 sc->gif_psrc == NULL || sc->gif_pdst == NULL) {
327 * We need to prepend the address family as
330 uint32_t af = dst->sa_family;
332 bpf_ptap(ifp->if_bpf, m, &af, sizeof(4));
335 ifp->if_obytes += m->m_pkthdr.len;
337 /* inner AF-specific encapsulation */
339 /* XXX should we check if our outer source is legal? */
341 /* dispatch to output logic based on outer AF */
342 switch (sc->gif_psrc->sa_family) {
345 error = in_gif_output(ifp, dst->sa_family, m);
350 error = in6_gif_output(ifp, dst->sa_family, m);
360 called = 0; /* reset recursion counter */
367 gif_output(struct ifnet *ifp, struct mbuf *m, struct sockaddr *dst,
372 ifnet_serialize_tx(ifp);
373 error = gif_output_serialized(ifp, m, dst, rt);
374 ifnet_deserialize_tx(ifp);
379 gif_input(struct mbuf *m, int af, struct ifnet *ifp)
389 m->m_pkthdr.rcvif = ifp;
393 * We need to prepend the address family as
398 bpf_ptap(ifp->if_bpf, m, &af1, sizeof(af1));
402 * Put the packet to the network layer input queue according to the
403 * specified address family.
404 * Note: older versions of gif_input directly called network layer
405 * input functions, e.g. ip6_input, here. We changed the policy to
406 * prevent too many recursive calls of such input functions, which
407 * might cause kernel panic. But the change may introduce another
408 * problem; if the input queue is full, packets are discarded.
409 * The kernel stack overflow really happened, and we believed
410 * queue-full rarely occurs, so we changed the policy.
429 ifp->if_ibytes += m->m_pkthdr.len;
430 netisr_dispatch(isr, m);
435 /* XXX how should we handle IPv6 scope on SIOC[GS]IFPHYADDR? */
437 gif_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
439 struct gif_softc *sc = (struct gif_softc*)ifp;
440 struct ifreq *ifr = (struct ifreq*)data;
442 struct sockaddr *dst, *src;
443 #ifdef SIOCSIFMTU /* xxx */
449 ifp->if_flags |= IFF_UP;
459 #ifdef SIOCSIFMTU /* xxx */
465 if (mtu < GIF_MTU_MIN || mtu > GIF_MTU_MAX)
469 #endif /* SIOCSIFMTU */
475 case SIOCSIFPHYADDR_IN6:
477 case SIOCSLIFPHYADDR:
481 src = (struct sockaddr *)
482 &(((struct in_aliasreq *)data)->ifra_addr);
483 dst = (struct sockaddr *)
484 &(((struct in_aliasreq *)data)->ifra_dstaddr);
488 case SIOCSIFPHYADDR_IN6:
489 src = (struct sockaddr *)
490 &(((struct in6_aliasreq *)data)->ifra_addr);
491 dst = (struct sockaddr *)
492 &(((struct in6_aliasreq *)data)->ifra_dstaddr);
495 case SIOCSLIFPHYADDR:
496 src = (struct sockaddr *)
497 &(((struct if_laddrreq *)data)->addr);
498 dst = (struct sockaddr *)
499 &(((struct if_laddrreq *)data)->dstaddr);
505 /* sa_family must be equal */
506 if (src->sa_family != dst->sa_family)
509 /* validate sa_len */
510 switch (src->sa_family) {
513 if (src->sa_len != sizeof(struct sockaddr_in))
519 if (src->sa_len != sizeof(struct sockaddr_in6))
526 switch (dst->sa_family) {
529 if (dst->sa_len != sizeof(struct sockaddr_in))
535 if (dst->sa_len != sizeof(struct sockaddr_in6))
543 /* check sa_family looks sane for the cmd */
546 if (src->sa_family == AF_INET)
550 case SIOCSIFPHYADDR_IN6:
551 if (src->sa_family == AF_INET6)
555 case SIOCSLIFPHYADDR:
556 /* checks done in the above */
560 error = gif_set_tunnel(&sc->gif_if, src, dst);
563 #ifdef SIOCDIFPHYADDR
565 gif_delete_tunnel(&sc->gif_if);
569 case SIOCGIFPSRCADDR:
571 case SIOCGIFPSRCADDR_IN6:
573 if (sc->gif_psrc == NULL) {
574 error = EADDRNOTAVAIL;
580 case SIOCGIFPSRCADDR:
581 dst = &ifr->ifr_addr;
582 size = sizeof(ifr->ifr_addr);
586 case SIOCGIFPSRCADDR_IN6:
587 dst = (struct sockaddr *)
588 &(((struct in6_ifreq *)data)->ifr_addr);
589 size = sizeof(((struct in6_ifreq *)data)->ifr_addr);
593 error = EADDRNOTAVAIL;
596 if (src->sa_len > size)
598 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
601 case SIOCGIFPDSTADDR:
603 case SIOCGIFPDSTADDR_IN6:
605 if (sc->gif_pdst == NULL) {
606 error = EADDRNOTAVAIL;
612 case SIOCGIFPDSTADDR:
613 dst = &ifr->ifr_addr;
614 size = sizeof(ifr->ifr_addr);
618 case SIOCGIFPDSTADDR_IN6:
619 dst = (struct sockaddr *)
620 &(((struct in6_ifreq *)data)->ifr_addr);
621 size = sizeof(((struct in6_ifreq *)data)->ifr_addr);
625 error = EADDRNOTAVAIL;
628 if (src->sa_len > size)
630 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
633 case SIOCGLIFPHYADDR:
634 if (sc->gif_psrc == NULL || sc->gif_pdst == NULL) {
635 error = EADDRNOTAVAIL;
641 dst = (struct sockaddr *)
642 &(((struct if_laddrreq *)data)->addr);
643 size = sizeof(((struct if_laddrreq *)data)->addr);
644 if (src->sa_len > size)
646 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
650 dst = (struct sockaddr *)
651 &(((struct if_laddrreq *)data)->dstaddr);
652 size = sizeof(((struct if_laddrreq *)data)->dstaddr);
653 if (src->sa_len > size)
655 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
659 /* if_ioctl() takes care of it */
671 gif_set_tunnel(struct ifnet *ifp, struct sockaddr *src, struct sockaddr *dst)
673 struct gif_softc *sc = (struct gif_softc *)ifp;
674 struct gif_softc *sc2;
675 struct sockaddr *osrc, *odst, *sa;
680 LIST_FOREACH(sc2, &gif_softc_list, gif_list) {
683 if (!sc2->gif_pdst || !sc2->gif_psrc)
685 if (sc2->gif_pdst->sa_family != dst->sa_family ||
686 sc2->gif_pdst->sa_len != dst->sa_len ||
687 sc2->gif_psrc->sa_family != src->sa_family ||
688 sc2->gif_psrc->sa_len != src->sa_len)
692 * Disallow parallel tunnels unless instructed
695 if (!parallel_tunnels &&
696 bcmp(sc2->gif_pdst, dst, dst->sa_len) == 0 &&
697 bcmp(sc2->gif_psrc, src, src->sa_len) == 0) {
698 error = EADDRNOTAVAIL;
702 /* XXX both end must be valid? (I mean, not 0.0.0.0) */
705 /* XXX we can detach from both, but be polite just in case */
707 switch (sc->gif_psrc->sa_family) {
721 sa = (struct sockaddr *)kmalloc(src->sa_len, M_IFADDR, M_WAITOK);
722 bcopy((caddr_t)src, (caddr_t)sa, src->sa_len);
726 sa = (struct sockaddr *)kmalloc(dst->sa_len, M_IFADDR, M_WAITOK);
727 bcopy((caddr_t)dst, (caddr_t)sa, dst->sa_len);
730 switch (sc->gif_psrc->sa_family) {
733 error = in_gif_attach(sc);
738 error = in6_gif_attach(sc);
744 kfree((caddr_t)sc->gif_psrc, M_IFADDR);
745 kfree((caddr_t)sc->gif_pdst, M_IFADDR);
752 kfree((caddr_t)osrc, M_IFADDR);
754 kfree((caddr_t)odst, M_IFADDR);
756 if (sc->gif_psrc && sc->gif_pdst)
757 ifp->if_flags |= IFF_RUNNING;
759 ifp->if_flags &= ~IFF_RUNNING;
765 if (sc->gif_psrc && sc->gif_pdst)
766 ifp->if_flags |= IFF_RUNNING;
768 ifp->if_flags &= ~IFF_RUNNING;
775 gif_delete_tunnel(struct ifnet *ifp)
777 struct gif_softc *sc = (struct gif_softc *)ifp;
782 kfree((caddr_t)sc->gif_psrc, M_IFADDR);
786 kfree((caddr_t)sc->gif_pdst, M_IFADDR);
789 /* it is safe to detach from both */
797 if (sc->gif_psrc && sc->gif_pdst)
798 ifp->if_flags |= IFF_RUNNING;
800 ifp->if_flags &= ~IFF_RUNNING;