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/ifq_var.h>
58 #include <net/netisr.h>
59 #include <net/route.h>
61 #include <net/if_clone.h>
63 #include <netinet/in.h>
64 #include <netinet/in_systm.h>
65 #include <netinet/ip.h>
67 #include <netinet/in_var.h>
68 #include <netinet/in_gif.h>
69 #include <netinet/ip_var.h>
74 #include <netinet/in.h>
76 #include <netinet6/in6_var.h>
77 #include <netinet/ip6.h>
78 #include <netinet6/ip6_var.h>
79 #include <netinet6/in6_gif.h>
80 #include <netinet6/ip6protosw.h>
83 #include <netinet/ip_encap.h>
86 #include <net/net_osdep.h>
90 static MALLOC_DEFINE(M_GIF, "gif", "Generic Tunnel Interface");
91 LIST_HEAD(, gif_softc) gif_softc_list;
93 int gif_clone_create (struct if_clone *, int, caddr_t);
94 int gif_clone_destroy (struct ifnet *);
96 struct if_clone gif_cloner = IF_CLONE_INITIALIZER("gif", gif_clone_create,
97 gif_clone_destroy, 0, IF_MAXUNIT);
99 static int gifmodevent (module_t, int, void *);
100 static void gif_clear_cache(struct gif_softc *sc);
102 SYSCTL_DECL(_net_link);
103 SYSCTL_NODE(_net_link, IFT_GIF, gif, CTLFLAG_RW, 0,
104 "Generic Tunnel Interface");
107 * This macro controls the default upper limitation on nesting of gif tunnels.
108 * Since, setting a large value to this macro with a careless configuration
109 * may introduce system crash, we don't allow any nestings by default.
110 * If you need to configure nested gif tunnels, you can define this macro
111 * in your kernel configuration file. However, if you do so, please be
112 * careful to configure the tunnels so that it won't make a loop.
114 #define MAX_GIF_NEST 1
116 static int max_gif_nesting = MAX_GIF_NEST;
117 SYSCTL_INT(_net_link_gif, OID_AUTO, max_nesting, CTLFLAG_RW,
118 &max_gif_nesting, 0, "Max nested tunnels");
121 * By default, we disallow creation of multiple tunnels between the same
122 * pair of addresses. Some applications require this functionality so
123 * we allow control over this check here.
126 static int parallel_tunnels = 1;
128 static int parallel_tunnels = 0;
130 SYSCTL_INT(_net_link_gif, OID_AUTO, parallel_tunnels, CTLFLAG_RW,
131 ¶llel_tunnels, 0, "Allow parallel tunnels?");
134 gif_clone_create(struct if_clone *ifc, int unit, caddr_t params)
136 struct gif_softc *sc;
138 sc = kmalloc (sizeof(struct gif_softc), M_GIF, M_WAITOK | M_ZERO);
140 sc->gif_if.if_softc = sc;
141 if_initname(&(sc->gif_if), GIFNAME, unit);
145 LIST_INSERT_HEAD(&gif_softc_list, sc, gif_list);
150 gifattach0(struct gif_softc *sc)
153 sc->encap_cookie4 = sc->encap_cookie6 = NULL;
155 sc->gif_if.if_addrlen = 0;
156 sc->gif_if.if_mtu = GIF_MTU;
157 sc->gif_if.if_flags = IFF_POINTOPOINT | IFF_MULTICAST;
159 /* turn off ingress filter */
160 sc->gif_if.if_flags |= IFF_LINK2;
162 sc->gif_if.if_ioctl = gif_ioctl;
163 sc->gif_if.if_output = gif_output;
164 sc->gif_if.if_type = IFT_GIF;
165 ifq_set_maxlen(&sc->gif_if.if_snd, IFQ_MAXLEN);
166 if_attach(&sc->gif_if, NULL);
167 bpfattach(&sc->gif_if, DLT_NULL, sizeof(u_int));
171 gif_clone_destroy(struct ifnet *ifp)
173 struct gif_softc *sc = ifp->if_softc;
176 gif_delete_tunnel(&sc->gif_if);
177 LIST_REMOVE(sc, gif_list);
179 if (sc->encap_cookie6 != NULL) {
180 err = encap_detach(sc->encap_cookie6);
181 KASSERT(err == 0, ("Unexpected error detaching encap_cookie6"));
185 if (sc->encap_cookie4 != NULL) {
186 err = encap_detach(sc->encap_cookie4);
187 KASSERT(err == 0, ("Unexpected error detaching encap_cookie4"));
201 gif_clear_cache(struct gif_softc *sc)
205 for (n = 0; n < ncpus; ++n) {
206 if (sc->gif_ro[n].ro_rt) {
207 RTFREE(sc->gif_ro[n].ro_rt);
208 sc->gif_ro[n].ro_rt = NULL;
211 if (sc->gif_ro6[n].ro_rt) {
212 RTFREE(sc->gif_ro6[n].ro_rt);
213 sc->gif_ro6[n].ro_rt = NULL;
220 gifmodevent(module_t mod, int type, void *data)
225 LIST_INIT(&gif_softc_list);
226 if_clone_attach(&gif_cloner);
229 ip6_gif_hlim = GIF_HLIM;
234 if_clone_detach(&gif_cloner);
236 while (!LIST_EMPTY(&gif_softc_list))
237 gif_clone_destroy(&LIST_FIRST(&gif_softc_list)->gif_if);
247 static moduledata_t gif_mod = {
253 DECLARE_MODULE(if_gif, gif_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
256 gif_encapcheck(const struct mbuf *m, int off, int proto, void *arg)
259 struct gif_softc *sc;
261 sc = (struct gif_softc *)arg;
265 if ((sc->gif_if.if_flags & IFF_UP) == 0)
268 /* no physical address */
269 if (!sc->gif_psrc || !sc->gif_pdst)
285 /* Bail on short packets */
286 if (m->m_pkthdr.len < sizeof(ip))
289 m_copydata(m, 0, sizeof(ip), (caddr_t)&ip);
294 if (sc->gif_psrc->sa_family != AF_INET ||
295 sc->gif_pdst->sa_family != AF_INET)
297 return gif_encapcheck4(m, off, proto, arg);
301 if (m->m_pkthdr.len < sizeof(struct ip6_hdr))
303 if (sc->gif_psrc->sa_family != AF_INET6 ||
304 sc->gif_pdst->sa_family != AF_INET6)
306 return gif_encapcheck6(m, off, proto, arg);
318 gif_output_serialized(struct ifnet *ifp, struct mbuf *m, struct sockaddr *dst,
321 struct gif_softc *sc = (struct gif_softc*)ifp;
323 static int called = 0; /* XXX: MUTEX */
326 * gif may cause infinite recursion calls when misconfigured.
327 * We'll prevent this by introducing upper limit.
328 * XXX: this mechanism may introduce another problem about
329 * mutual exclusion of the variable CALLED, especially if we
332 if (++called > max_gif_nesting) {
334 "gif_output: recursively called too many times(%d)\n",
337 error = EIO; /* is there better errno? */
341 m->m_flags &= ~(M_BCAST|M_MCAST);
342 if (!(ifp->if_flags & IFF_UP) ||
343 sc->gif_psrc == NULL || sc->gif_pdst == NULL) {
353 * We need to prepend the address family as
356 uint32_t af = dst->sa_family;
358 bpf_ptap(ifp->if_bpf, m, &af, sizeof(af));
362 IFNET_STAT_INC(ifp, opackets, 1);
363 IFNET_STAT_INC(ifp, obytes, m->m_pkthdr.len);
365 /* inner AF-specific encapsulation */
367 /* XXX should we check if our outer source is legal? */
369 /* dispatch to output logic based on outer AF */
370 switch (sc->gif_psrc->sa_family) {
373 error = in_gif_output(ifp, dst->sa_family, m);
378 error = in6_gif_output(ifp, dst->sa_family, m);
388 called = 0; /* reset recursion counter */
390 IFNET_STAT_INC(ifp, oerrors, 1);
395 gif_output(struct ifnet *ifp, struct mbuf *m, struct sockaddr *dst,
398 const struct ifaltq_subque *ifsq = ifq_get_subq_default(&ifp->if_snd);
401 ifnet_serialize_tx(ifp, ifsq);
402 error = gif_output_serialized(ifp, m, dst, rt);
403 ifnet_deserialize_tx(ifp, ifsq);
408 gif_input(struct mbuf *m, int af, struct ifnet *ifp)
418 m->m_pkthdr.rcvif = ifp;
424 * We need to prepend the address family as
429 bpf_ptap(ifp->if_bpf, m, &af1, sizeof(af1));
435 * Put the packet to the network layer input queue according to the
436 * specified address family.
437 * Note: older versions of gif_input directly called network layer
438 * input functions, e.g. ip6_input, here. We changed the policy to
439 * prevent too many recursive calls of such input functions, which
440 * might cause kernel panic. But the change may introduce another
441 * problem; if the input queue is full, packets are discarded.
442 * The kernel stack overflow really happened, and we believed
443 * queue-full rarely occurs, so we changed the policy.
461 IFNET_STAT_INC(ifp, ipackets, 1);
462 IFNET_STAT_INC(ifp, ibytes, m->m_pkthdr.len);
463 m->m_flags &= ~M_HASH;
464 netisr_queue(isr, m);
469 /* XXX how should we handle IPv6 scope on SIOC[GS]IFPHYADDR? */
471 gif_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
473 struct gif_softc *sc = (struct gif_softc*)ifp;
474 struct ifreq *ifr = (struct ifreq*)data;
476 struct sockaddr *dst, *src;
477 #ifdef SIOCSIFMTU /* xxx */
483 ifp->if_flags |= IFF_UP;
493 #ifdef SIOCSIFMTU /* xxx */
499 if (mtu < GIF_MTU_MIN || mtu > GIF_MTU_MAX)
503 #endif /* SIOCSIFMTU */
509 case SIOCSIFPHYADDR_IN6:
511 case SIOCSLIFPHYADDR:
515 src = (struct sockaddr *)
516 &(((struct in_aliasreq *)data)->ifra_addr);
517 dst = (struct sockaddr *)
518 &(((struct in_aliasreq *)data)->ifra_dstaddr);
522 case SIOCSIFPHYADDR_IN6:
523 src = (struct sockaddr *)
524 &(((struct in6_aliasreq *)data)->ifra_addr);
525 dst = (struct sockaddr *)
526 &(((struct in6_aliasreq *)data)->ifra_dstaddr);
529 case SIOCSLIFPHYADDR:
530 src = (struct sockaddr *)
531 &(((struct if_laddrreq *)data)->addr);
532 dst = (struct sockaddr *)
533 &(((struct if_laddrreq *)data)->dstaddr);
539 /* sa_family must be equal */
540 if (src->sa_family != dst->sa_family)
543 /* validate sa_len */
544 switch (src->sa_family) {
547 if (src->sa_len != sizeof(struct sockaddr_in))
553 if (src->sa_len != sizeof(struct sockaddr_in6))
560 switch (dst->sa_family) {
563 if (dst->sa_len != sizeof(struct sockaddr_in))
569 if (dst->sa_len != sizeof(struct sockaddr_in6))
577 /* check sa_family looks sane for the cmd */
580 if (src->sa_family == AF_INET)
584 case SIOCSIFPHYADDR_IN6:
585 if (src->sa_family == AF_INET6)
589 case SIOCSLIFPHYADDR:
590 /* checks done in the above */
594 error = gif_set_tunnel(&sc->gif_if, src, dst);
597 #ifdef SIOCDIFPHYADDR
599 gif_delete_tunnel(&sc->gif_if);
603 case SIOCGIFPSRCADDR:
605 case SIOCGIFPSRCADDR_IN6:
607 if (sc->gif_psrc == NULL) {
608 error = EADDRNOTAVAIL;
614 case SIOCGIFPSRCADDR:
615 dst = &ifr->ifr_addr;
616 size = sizeof(ifr->ifr_addr);
620 case SIOCGIFPSRCADDR_IN6:
621 dst = (struct sockaddr *)
622 &(((struct in6_ifreq *)data)->ifr_addr);
623 size = sizeof(((struct in6_ifreq *)data)->ifr_addr);
627 error = EADDRNOTAVAIL;
630 if (src->sa_len > size)
632 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
635 case SIOCGIFPDSTADDR:
637 case SIOCGIFPDSTADDR_IN6:
639 if (sc->gif_pdst == NULL) {
640 error = EADDRNOTAVAIL;
646 case SIOCGIFPDSTADDR:
647 dst = &ifr->ifr_addr;
648 size = sizeof(ifr->ifr_addr);
652 case SIOCGIFPDSTADDR_IN6:
653 dst = (struct sockaddr *)
654 &(((struct in6_ifreq *)data)->ifr_addr);
655 size = sizeof(((struct in6_ifreq *)data)->ifr_addr);
659 error = EADDRNOTAVAIL;
662 if (src->sa_len > size)
664 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
667 case SIOCGLIFPHYADDR:
668 if (sc->gif_psrc == NULL || sc->gif_pdst == NULL) {
669 error = EADDRNOTAVAIL;
675 dst = (struct sockaddr *)
676 &(((struct if_laddrreq *)data)->addr);
677 size = sizeof(((struct if_laddrreq *)data)->addr);
678 if (src->sa_len > size)
680 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
684 dst = (struct sockaddr *)
685 &(((struct if_laddrreq *)data)->dstaddr);
686 size = sizeof(((struct if_laddrreq *)data)->dstaddr);
687 if (src->sa_len > size)
689 bcopy((caddr_t)src, (caddr_t)dst, src->sa_len);
693 /* if_ioctl() takes care of it */
705 gif_set_tunnel(struct ifnet *ifp, struct sockaddr *src, struct sockaddr *dst)
707 struct gif_softc *sc = (struct gif_softc *)ifp;
708 struct gif_softc *sc2;
709 struct sockaddr *osrc, *odst, *sa;
714 LIST_FOREACH(sc2, &gif_softc_list, gif_list) {
717 if (!sc2->gif_pdst || !sc2->gif_psrc)
719 if (sc2->gif_pdst->sa_family != dst->sa_family ||
720 sc2->gif_pdst->sa_len != dst->sa_len ||
721 sc2->gif_psrc->sa_family != src->sa_family ||
722 sc2->gif_psrc->sa_len != src->sa_len)
726 * Disallow parallel tunnels unless instructed
729 if (!parallel_tunnels &&
730 bcmp(sc2->gif_pdst, dst, dst->sa_len) == 0 &&
731 bcmp(sc2->gif_psrc, src, src->sa_len) == 0) {
732 error = EADDRNOTAVAIL;
736 /* XXX both end must be valid? (I mean, not 0.0.0.0) */
739 /* XXX we can detach from both, but be polite just in case */
741 switch (sc->gif_psrc->sa_family) {
757 sa = (struct sockaddr *)kmalloc(src->sa_len, M_IFADDR, M_WAITOK);
758 bcopy((caddr_t)src, (caddr_t)sa, src->sa_len);
762 sa = (struct sockaddr *)kmalloc(dst->sa_len, M_IFADDR, M_WAITOK);
763 bcopy((caddr_t)dst, (caddr_t)sa, dst->sa_len);
766 switch (sc->gif_psrc->sa_family) {
769 error = in_gif_attach(sc);
774 error = in6_gif_attach(sc);
780 kfree((caddr_t)sc->gif_psrc, M_IFADDR);
781 kfree((caddr_t)sc->gif_pdst, M_IFADDR);
788 kfree((caddr_t)osrc, M_IFADDR);
790 kfree((caddr_t)odst, M_IFADDR);
792 if (sc->gif_psrc && sc->gif_pdst)
793 ifp->if_flags |= IFF_RUNNING;
795 ifp->if_flags &= ~IFF_RUNNING;
801 if (sc->gif_psrc && sc->gif_pdst)
802 ifp->if_flags |= IFF_RUNNING;
804 ifp->if_flags &= ~IFF_RUNNING;
811 gif_delete_tunnel(struct ifnet *ifp)
813 struct gif_softc *sc = (struct gif_softc *)ifp;
818 kfree((caddr_t)sc->gif_psrc, M_IFADDR);
822 kfree((caddr_t)sc->gif_pdst, M_IFADDR);
825 /* it is safe to detach from both */
834 if (sc->gif_psrc && sc->gif_pdst)
835 ifp->if_flags |= IFF_RUNNING;
837 ifp->if_flags &= ~IFF_RUNNING;