Home | History | Annotate | Line # | Download | only in net
if_gif.c revision 1.150
      1 /*	$NetBSD: if_gif.c,v 1.150 2019/10/30 03:45:59 knakahara Exp $	*/
      2 /*	$KAME: if_gif.c,v 1.76 2001/08/20 02:01:02 kjc Exp $	*/
      3 
      4 /*
      5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
      6  * All rights reserved.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  * 3. Neither the name of the project nor the names of its contributors
     17  *    may be used to endorse or promote products derived from this software
     18  *    without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
     21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
     24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     30  * SUCH DAMAGE.
     31  */
     32 
     33 #include <sys/cdefs.h>
     34 __KERNEL_RCSID(0, "$NetBSD: if_gif.c,v 1.150 2019/10/30 03:45:59 knakahara Exp $");
     35 
     36 #ifdef _KERNEL_OPT
     37 #include "opt_inet.h"
     38 #include "opt_net_mpsafe.h"
     39 #endif
     40 
     41 #include <sys/param.h>
     42 #include <sys/systm.h>
     43 #include <sys/kernel.h>
     44 #include <sys/mbuf.h>
     45 #include <sys/socket.h>
     46 #include <sys/sockio.h>
     47 #include <sys/errno.h>
     48 #include <sys/ioctl.h>
     49 #include <sys/time.h>
     50 #include <sys/socketvar.h>
     51 #include <sys/syslog.h>
     52 #include <sys/proc.h>
     53 #include <sys/cpu.h>
     54 #include <sys/intr.h>
     55 #include <sys/kmem.h>
     56 #include <sys/sysctl.h>
     57 #include <sys/xcall.h>
     58 #include <sys/device.h>
     59 #include <sys/module.h>
     60 #include <sys/mutex.h>
     61 #include <sys/pserialize.h>
     62 #include <sys/psref.h>
     63 
     64 #include <net/if.h>
     65 #include <net/if_types.h>
     66 #include <net/netisr.h>
     67 #include <net/route.h>
     68 #include <net/bpf.h>
     69 
     70 #include <netinet/in.h>
     71 #include <netinet/in_systm.h>
     72 #include <netinet/ip.h>
     73 #ifdef	INET
     74 #include <netinet/in_var.h>
     75 #endif	/* INET */
     76 #include <netinet/in_gif.h>
     77 
     78 #ifdef INET6
     79 #ifndef INET
     80 #include <netinet/in.h>
     81 #endif
     82 #include <netinet6/in6_var.h>
     83 #include <netinet/ip6.h>
     84 #include <netinet6/ip6_var.h>
     85 #include <netinet6/in6_gif.h>
     86 #endif /* INET6 */
     87 
     88 #include <netinet/ip_encap.h>
     89 #include <net/if_gif.h>
     90 
     91 #include "ioconf.h"
     92 
     93 #ifdef NET_MPSAFE
     94 #define GIF_MPSAFE	1
     95 #endif
     96 
     97 /*
     98  * gif global variable definitions
     99  */
    100 static struct {
    101 	LIST_HEAD(gif_sclist, gif_softc) list;
    102 	kmutex_t lock;
    103 } gif_softcs __cacheline_aligned;
    104 
    105 struct psref_class *gv_psref_class __read_mostly;
    106 
    107 static int	gifattach0(struct gif_softc *);
    108 static int	gif_output(struct ifnet *, struct mbuf *,
    109 			   const struct sockaddr *, const struct rtentry *);
    110 static void	gif_start(struct ifnet *);
    111 static int	gif_transmit(struct ifnet *, struct mbuf *);
    112 static int	gif_transmit_direct(struct gif_variant *, struct mbuf *);
    113 static int	gif_ioctl(struct ifnet *, u_long, void *);
    114 static int	gif_set_tunnel(struct ifnet *, struct sockaddr *,
    115 			       struct sockaddr *);
    116 static void	gif_delete_tunnel(struct ifnet *);
    117 
    118 static int	gif_clone_create(struct if_clone *, int);
    119 static int	gif_clone_destroy(struct ifnet *);
    120 static int	gif_check_nesting(struct ifnet *, struct mbuf *);
    121 
    122 static int	gif_encap_attach(struct gif_variant *);
    123 static int	gif_encap_detach(struct gif_variant *);
    124 
    125 static void	gif_update_variant(struct gif_softc *, struct gif_variant *);
    126 
    127 static struct if_clone gif_cloner =
    128     IF_CLONE_INITIALIZER("gif", gif_clone_create, gif_clone_destroy);
    129 
    130 #ifndef MAX_GIF_NEST
    131 /*
    132  * This macro controls the upper limitation on nesting of gif tunnels.
    133  * Since, setting a large value to this macro with a careless configuration
    134  * may introduce system crash, we don't allow any nestings by default.
    135  * If you need to configure nested gif tunnels, you can define this macro
    136  * in your kernel configuration file.  However, if you do so, please be
    137  * careful to configure the tunnels so that it won't make a loop.
    138  */
    139 #define MAX_GIF_NEST 1
    140 #endif
    141 static int max_gif_nesting = MAX_GIF_NEST;
    142 
    143 static struct sysctllog *gif_sysctl;
    144 
    145 #ifdef INET6
    146 static int
    147 sysctl_gif_pmtu_global(SYSCTLFN_ARGS)
    148 {
    149 	int error, pmtu;
    150 	struct sysctlnode node = *rnode;
    151 
    152 	pmtu = ip6_gif_pmtu;
    153 	node.sysctl_data = &pmtu;
    154 	error = sysctl_lookup(SYSCTLFN_CALL(&node));
    155 	if (error || newp == NULL)
    156 		return error;
    157 
    158 	switch (pmtu) {
    159 	case GIF_PMTU_MINMTU:
    160 	case GIF_PMTU_OUTERMTU:
    161 		ip6_gif_pmtu = pmtu;
    162 		break;
    163 	default:
    164 		return EINVAL;
    165 	}
    166 
    167 	return 0;
    168 }
    169 
    170 static int
    171 sysctl_gif_pmtu_perif(SYSCTLFN_ARGS)
    172 {
    173 	int error, pmtu;
    174 	struct sysctlnode node = *rnode;
    175 	struct gif_softc *sc = (struct gif_softc *)node.sysctl_data;
    176 
    177 	pmtu = sc->gif_pmtu;
    178 	node.sysctl_data = &pmtu;
    179 	error = sysctl_lookup(SYSCTLFN_CALL(&node));
    180 	if (error || newp == NULL)
    181 		return error;
    182 
    183 	switch (pmtu) {
    184 	case GIF_PMTU_SYSDEFAULT:
    185 	case GIF_PMTU_MINMTU:
    186 	case GIF_PMTU_OUTERMTU:
    187 		sc->gif_pmtu = pmtu;
    188 		break;
    189 	default:
    190 		return EINVAL;
    191 	}
    192 
    193 	return 0;
    194 }
    195 #endif
    196 
    197 static void
    198 gif_sysctl_setup(void)
    199 {
    200 	gif_sysctl = NULL;
    201 
    202 #ifdef INET
    203 	/*
    204 	 * Previously create "net.inet.ip" entry to avoid sysctl_createv error.
    205 	 */
    206 	sysctl_createv(NULL, 0, NULL, NULL,
    207 		       CTLFLAG_PERMANENT,
    208 		       CTLTYPE_NODE, "inet",
    209 		       SYSCTL_DESCR("PF_INET related settings"),
    210 		       NULL, 0, NULL, 0,
    211 		       CTL_NET, PF_INET, CTL_EOL);
    212 	sysctl_createv(NULL, 0, NULL, NULL,
    213 		       CTLFLAG_PERMANENT,
    214 		       CTLTYPE_NODE, "ip",
    215 		       SYSCTL_DESCR("IPv4 related settings"),
    216 		       NULL, 0, NULL, 0,
    217 		       CTL_NET, PF_INET, IPPROTO_IP, CTL_EOL);
    218 
    219 	sysctl_createv(&gif_sysctl, 0, NULL, NULL,
    220 		       CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
    221 		       CTLTYPE_INT, "gifttl",
    222 		       SYSCTL_DESCR("Default TTL for a gif tunnel datagram"),
    223 		       NULL, 0, &ip_gif_ttl, 0,
    224 		       CTL_NET, PF_INET, IPPROTO_IP,
    225 		       IPCTL_GIF_TTL, CTL_EOL);
    226 #endif
    227 #ifdef INET6
    228 	/*
    229 	 * Previously create "net.inet6.ip6" entry to avoid sysctl_createv error.
    230 	 */
    231 	sysctl_createv(NULL, 0, NULL, NULL,
    232 		       CTLFLAG_PERMANENT,
    233 		       CTLTYPE_NODE, "inet6",
    234 		       SYSCTL_DESCR("PF_INET6 related settings"),
    235 		       NULL, 0, NULL, 0,
    236 		       CTL_NET, PF_INET6, CTL_EOL);
    237 	sysctl_createv(NULL, 0, NULL, NULL,
    238 		       CTLFLAG_PERMANENT,
    239 		       CTLTYPE_NODE, "ip6",
    240 		       SYSCTL_DESCR("IPv6 related settings"),
    241 		       NULL, 0, NULL, 0,
    242 		       CTL_NET, PF_INET6, IPPROTO_IPV6, CTL_EOL);
    243 
    244 	sysctl_createv(&gif_sysctl, 0, NULL, NULL,
    245 		       CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
    246 		       CTLTYPE_INT, "gifhlim",
    247 		       SYSCTL_DESCR("Default hop limit for a gif tunnel datagram"),
    248 		       NULL, 0, &ip6_gif_hlim, 0,
    249 		       CTL_NET, PF_INET6, IPPROTO_IPV6,
    250 		       IPV6CTL_GIF_HLIM, CTL_EOL);
    251 
    252 	sysctl_createv(&gif_sysctl, 0, NULL, NULL,
    253 		       CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
    254 		       CTLTYPE_INT, "gifpmtu",
    255 		       SYSCTL_DESCR("Default Path MTU setting for gif tunnels"),
    256 		       sysctl_gif_pmtu_global, 0, NULL, 0,
    257 		       CTL_NET, PF_INET6, IPPROTO_IPV6,
    258 		       IPV6CTL_GIF_PMTU, CTL_EOL);
    259 #endif
    260 }
    261 
    262 static void
    263 gif_perif_sysctl_setup(struct sysctllog **clog, struct gif_softc *sc)
    264 {
    265 #ifdef INET6
    266 	const struct sysctlnode *cnode, *rnode;
    267 	struct ifnet *ifp = &sc->gif_if;
    268 	const char *ifname = ifp->if_xname;
    269 	int rv;
    270 
    271 	/*
    272 	 * Already created in sysctl_sndq_setup().
    273 	 */
    274 	sysctl_createv(clog, 0, NULL, &rnode,
    275 		       CTLFLAG_PERMANENT,
    276 		       CTLTYPE_NODE, "interfaces",
    277 		       SYSCTL_DESCR("Per-interface controls"),
    278 		       NULL, 0, NULL, 0,
    279 		       CTL_NET, CTL_CREATE, CTL_EOL);
    280 	sysctl_createv(clog, 0, &rnode, &rnode,
    281 		       CTLFLAG_PERMANENT,
    282 		       CTLTYPE_NODE, ifname,
    283 		       SYSCTL_DESCR("Interface controls"),
    284 		       NULL, 0, NULL, 0,
    285 		       CTL_CREATE, CTL_EOL);
    286 
    287 	rv = sysctl_createv(clog, 0, &rnode, &cnode,
    288 			    CTLFLAG_PERMANENT,
    289 			    CTLTYPE_INT, "pmtu",
    290 			    SYSCTL_DESCR("Path MTU setting for this gif tunnel"),
    291 			    sysctl_gif_pmtu_perif, 0, (void *)sc, 0,
    292 			    CTL_CREATE, CTL_EOL);
    293 	if (rv != 0)
    294 		log(LOG_WARNING, "%s: could not attach sysctl node pmtu\n", ifname);
    295 
    296 	sc->gif_pmtu = GIF_PMTU_SYSDEFAULT;
    297 #endif
    298 }
    299 
    300 /* ARGSUSED */
    301 void
    302 gifattach(int count)
    303 {
    304 	/*
    305 	 * Nothing to do here, initialization is handled by the
    306 	 * module initialization code in gifinit() below).
    307 	 */
    308 }
    309 
    310 static void
    311 gifinit(void)
    312 {
    313 
    314 	mutex_init(&gif_softcs.lock, MUTEX_DEFAULT, IPL_NONE);
    315 	LIST_INIT(&gif_softcs.list);
    316 	if_clone_attach(&gif_cloner);
    317 
    318 	gv_psref_class = psref_class_create("gifvar", IPL_SOFTNET);
    319 
    320 	gif_sysctl_setup();
    321 }
    322 
    323 static int
    324 gifdetach(void)
    325 {
    326 	int error = 0;
    327 
    328 	mutex_enter(&gif_softcs.lock);
    329 	if (!LIST_EMPTY(&gif_softcs.list)) {
    330 		mutex_exit(&gif_softcs.lock);
    331 		error = EBUSY;
    332 	}
    333 
    334 	if (error == 0) {
    335 		psref_class_destroy(gv_psref_class);
    336 
    337 		if_clone_detach(&gif_cloner);
    338 		sysctl_teardown(&gif_sysctl);
    339 	}
    340 
    341 	return error;
    342 }
    343 
    344 static int
    345 gif_clone_create(struct if_clone *ifc, int unit)
    346 {
    347 	struct gif_softc *sc;
    348 	struct gif_variant *var;
    349 	struct ifnet *ifp;
    350 	int rv;
    351 
    352 	sc = kmem_zalloc(sizeof(struct gif_softc), KM_SLEEP);
    353 
    354 	if_initname(&sc->gif_if, ifc->ifc_name, unit);
    355 
    356 	rv = gifattach0(sc);
    357 	if (rv != 0) {
    358 		kmem_free(sc, sizeof(struct gif_softc));
    359 		return rv;
    360 	}
    361 
    362 	ifp = &sc->gif_if;
    363 	gif_perif_sysctl_setup(&ifp->if_sysctl_log, sc);
    364 
    365 	var = kmem_zalloc(sizeof(*var), KM_SLEEP);
    366 	var->gv_softc = sc;
    367 	psref_target_init(&var->gv_psref, gv_psref_class);
    368 
    369 	sc->gif_var = var;
    370 	mutex_init(&sc->gif_lock, MUTEX_DEFAULT, IPL_NONE);
    371 	sc->gif_psz = pserialize_create();
    372 
    373 	sc->gif_ro_percpu = if_tunnel_alloc_ro_percpu();
    374 	mutex_enter(&gif_softcs.lock);
    375 	LIST_INSERT_HEAD(&gif_softcs.list, sc, gif_list);
    376 	mutex_exit(&gif_softcs.lock);
    377 	return 0;
    378 }
    379 
    380 static int
    381 gifattach0(struct gif_softc *sc)
    382 {
    383 	int rv;
    384 
    385 	sc->gif_if.if_addrlen = 0;
    386 	sc->gif_if.if_mtu    = GIF_MTU;
    387 	sc->gif_if.if_flags  = IFF_POINTOPOINT | IFF_MULTICAST;
    388 	sc->gif_if.if_extflags  = IFEF_NO_LINK_STATE_CHANGE;
    389 #ifdef GIF_MPSAFE
    390 	sc->gif_if.if_extflags  |= IFEF_MPSAFE;
    391 #endif
    392 	sc->gif_if.if_ioctl  = gif_ioctl;
    393 	sc->gif_if.if_output = gif_output;
    394 	sc->gif_if.if_start = gif_start;
    395 	sc->gif_if.if_transmit = gif_transmit;
    396 	sc->gif_if.if_type   = IFT_GIF;
    397 	sc->gif_if.if_dlt    = DLT_NULL;
    398 	sc->gif_if.if_softc  = sc;
    399 	IFQ_SET_READY(&sc->gif_if.if_snd);
    400 	rv = if_initialize(&sc->gif_if);
    401 	if (rv != 0)
    402 		return rv;
    403 
    404 	if_alloc_sadl(&sc->gif_if);
    405 	bpf_attach(&sc->gif_if, DLT_NULL, sizeof(u_int));
    406 	if_register(&sc->gif_if);
    407 	return 0;
    408 }
    409 
    410 static int
    411 gif_clone_destroy(struct ifnet *ifp)
    412 {
    413 	struct gif_softc *sc = (void *) ifp;
    414 	struct gif_variant *var;
    415 
    416 	LIST_REMOVE(sc, gif_list);
    417 
    418 	gif_delete_tunnel(&sc->gif_if);
    419 	bpf_detach(ifp);
    420 	if_detach(ifp);
    421 
    422 	if_tunnel_free_ro_percpu(sc->gif_ro_percpu);
    423 
    424 	pserialize_destroy(sc->gif_psz);
    425 	mutex_destroy(&sc->gif_lock);
    426 
    427 	var = sc->gif_var;
    428 	kmem_free(var, sizeof(*var));
    429 	kmem_free(sc, sizeof(struct gif_softc));
    430 
    431 	return 0;
    432 }
    433 
    434 #ifdef GIF_ENCAPCHECK
    435 int
    436 gif_encapcheck(struct mbuf *m, int off, int proto, void *arg)
    437 {
    438 	struct ip ip;
    439 	struct gif_softc *sc;
    440 	struct gif_variant *var;
    441 	struct psref psref;
    442 	int ret = 0;
    443 
    444 	sc = arg;
    445 	if (sc == NULL)
    446 		return 0;
    447 
    448 	if ((sc->gif_if.if_flags & IFF_UP) == 0)
    449 		return 0;
    450 
    451 	var = gif_getref_variant(sc, &psref);
    452 	/* no physical address */
    453 	if (var->gv_psrc == NULL || var->gv_pdst == NULL)
    454 		goto out;
    455 
    456 	switch (proto) {
    457 #ifdef INET
    458 	case IPPROTO_IPV4:
    459 		break;
    460 #endif
    461 #ifdef INET6
    462 	case IPPROTO_IPV6:
    463 		break;
    464 #endif
    465 	default:
    466 		goto out;
    467 	}
    468 
    469 	/* Bail on short packets */
    470 	KASSERT(m->m_flags & M_PKTHDR);
    471 	if (m->m_pkthdr.len < sizeof(ip))
    472 		goto  out;
    473 
    474 	m_copydata(m, 0, sizeof(ip), &ip);
    475 
    476 	switch (ip.ip_v) {
    477 #ifdef INET
    478 	case 4:
    479 		if (var->gv_psrc->sa_family != AF_INET ||
    480 		    var->gv_pdst->sa_family != AF_INET)
    481 			goto out;
    482 		ret = gif_encapcheck4(m, off, proto, var);
    483 		break;
    484 #endif
    485 #ifdef INET6
    486 	case 6:
    487 		if (m->m_pkthdr.len < sizeof(struct ip6_hdr))
    488 			goto out;
    489 		if (var->gv_psrc->sa_family != AF_INET6 ||
    490 		    var->gv_pdst->sa_family != AF_INET6)
    491 			goto out;
    492 		ret = gif_encapcheck6(m, off, proto, var);
    493 		break;
    494 #endif
    495 	default:
    496 		goto out;
    497 	}
    498 
    499 out:
    500 	gif_putref_variant(var, &psref);
    501 	return ret;
    502 }
    503 #endif
    504 
    505 /*
    506  * gif may cause infinite recursion calls when misconfigured.
    507  * We'll prevent this by introducing upper limit.
    508  */
    509 static int
    510 gif_check_nesting(struct ifnet *ifp, struct mbuf *m)
    511 {
    512 
    513 	return if_tunnel_check_nesting(ifp, m, max_gif_nesting);
    514 }
    515 
    516 static int
    517 gif_output(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst,
    518     const struct rtentry *rt)
    519 {
    520 	struct gif_softc *sc = ifp->if_softc;
    521 	struct gif_variant *var = NULL;
    522 	struct psref psref;
    523 	int error = 0;
    524 
    525 	IFQ_CLASSIFY(&ifp->if_snd, m, dst->sa_family);
    526 
    527 	if ((error = gif_check_nesting(ifp, m)) != 0) {
    528 		m_freem(m);
    529 		goto end;
    530 	}
    531 
    532 	if ((ifp->if_flags & IFF_UP) == 0) {
    533 		m_freem(m);
    534 		error = ENETDOWN;
    535 		goto end;
    536 	}
    537 
    538 	var = gif_getref_variant(sc, &psref);
    539 	if (var->gv_psrc == NULL || var->gv_pdst == NULL) {
    540 		m_freem(m);
    541 		error = ENETDOWN;
    542 		goto end;
    543 	}
    544 	/* XXX should we check if our outer source is legal? */
    545 
    546 	m->m_flags &= ~(M_BCAST | M_MCAST);
    547 
    548 	/* use DLT_NULL encapsulation here to pass inner af type */
    549 	M_PREPEND(m, sizeof(int), M_DONTWAIT);
    550 	if (!m) {
    551 		error = ENOBUFS;
    552 		goto end;
    553 	}
    554 	*mtod(m, int *) = dst->sa_family;
    555 
    556 	/* Clear checksum-offload flags. */
    557 	m->m_pkthdr.csum_flags = 0;
    558 	m->m_pkthdr.csum_data = 0;
    559 
    560 	error = if_transmit_lock(ifp, m);
    561 
    562 end:
    563 	if (var != NULL)
    564 		gif_putref_variant(var, &psref);
    565 	if (error)
    566 		ifp->if_oerrors++;
    567 	return error;
    568 }
    569 
    570 static void
    571 gif_start(struct ifnet *ifp)
    572 {
    573 	struct gif_softc *sc;
    574 	struct gif_variant *var;
    575 	struct mbuf *m;
    576 	struct psref psref;
    577 	int family;
    578 	int len;
    579 	int error;
    580 
    581 	sc = ifp->if_softc;
    582 	var = gif_getref_variant(sc, &psref);
    583 
    584 	KASSERT(var->gv_output != NULL);
    585 
    586 	/* output processing */
    587 	while (1) {
    588 		IFQ_DEQUEUE(&sc->gif_if.if_snd, m);
    589 		if (m == NULL)
    590 			break;
    591 
    592 		/* grab and chop off inner af type */
    593 		if (sizeof(int) > m->m_len) {
    594 			m = m_pullup(m, sizeof(int));
    595 			if (!m) {
    596 				ifp->if_oerrors++;
    597 				continue;
    598 			}
    599 		}
    600 		family = *mtod(m, int *);
    601 		bpf_mtap(ifp, m, BPF_D_OUT);
    602 		m_adj(m, sizeof(int));
    603 
    604 		len = m->m_pkthdr.len;
    605 
    606 		error = var->gv_output(var, family, m);
    607 		if (error)
    608 			ifp->if_oerrors++;
    609 		else {
    610 			ifp->if_opackets++;
    611 			ifp->if_obytes += len;
    612 		}
    613 	}
    614 
    615 	gif_putref_variant(var, &psref);
    616 }
    617 
    618 static int
    619 gif_transmit(struct ifnet *ifp, struct mbuf *m)
    620 {
    621 	struct gif_softc *sc;
    622 	struct gif_variant *var;
    623 	struct psref psref;
    624 	int error;
    625 
    626 	sc = ifp->if_softc;
    627 
    628 	/* output processing */
    629 	if (m == NULL)
    630 		return EINVAL;
    631 
    632 	var = gif_getref_variant(sc, &psref);
    633 	error = gif_transmit_direct(var, m);
    634 	gif_putref_variant(var, &psref);
    635 
    636 	return error;
    637 }
    638 
    639 static int
    640 gif_transmit_direct(struct gif_variant *var, struct mbuf *m)
    641 {
    642 	struct ifnet *ifp = &var->gv_softc->gif_if;
    643 	int error;
    644 	int family;
    645 	int len;
    646 
    647 	KASSERT(gif_heldref_variant(var));
    648 	KASSERT(var->gv_output != NULL);
    649 
    650 	/* grab and chop off inner af type */
    651 	if (sizeof(int) > m->m_len) {
    652 		m = m_pullup(m, sizeof(int));
    653 		if (!m) {
    654 			ifp->if_oerrors++;
    655 			return ENOBUFS;
    656 		}
    657 	}
    658 	family = *mtod(m, int *);
    659 	bpf_mtap(ifp, m, BPF_D_OUT);
    660 	m_adj(m, sizeof(int));
    661 
    662 	len = m->m_pkthdr.len;
    663 
    664 	error = var->gv_output(var, family, m);
    665 	if (error)
    666 		ifp->if_oerrors++;
    667 	else {
    668 		ifp->if_opackets++;
    669 		ifp->if_obytes += len;
    670 	}
    671 
    672 	return error;
    673 }
    674 
    675 void
    676 gif_input(struct mbuf *m, int af, struct ifnet *ifp)
    677 {
    678 	pktqueue_t *pktq;
    679 	size_t pktlen;
    680 
    681 	if (ifp == NULL) {
    682 		/* just in case */
    683 		m_freem(m);
    684 		return;
    685 	}
    686 
    687 	m_set_rcvif(m, ifp);
    688 	pktlen = m->m_pkthdr.len;
    689 
    690 	bpf_mtap_af(ifp, af, m, BPF_D_IN);
    691 
    692 	/*
    693 	 * Put the packet to the network layer input queue according to the
    694 	 * specified address family.  Note: we avoid direct call to the
    695 	 * input function of the network layer in order to avoid recursion.
    696 	 * This may be revisited in the future.
    697 	 */
    698 	switch (af) {
    699 #ifdef INET
    700 	case AF_INET:
    701 		pktq = ip_pktq;
    702 		break;
    703 #endif
    704 #ifdef INET6
    705 	case AF_INET6:
    706 		pktq = ip6_pktq;
    707 		break;
    708 #endif
    709 	default:
    710 		m_freem(m);
    711 		return;
    712 	}
    713 
    714 #ifdef GIF_MPSAFE
    715 	const u_int h = curcpu()->ci_index;
    716 #else
    717 	const uint32_t h = pktq_rps_hash(m);
    718 #endif
    719 	if (__predict_true(pktq_enqueue(pktq, m, h))) {
    720 		ifp->if_ibytes += pktlen;
    721 		ifp->if_ipackets++;
    722 	} else {
    723 		m_freem(m);
    724 	}
    725 }
    726 
    727 /* XXX how should we handle IPv6 scope on SIOC[GS]IFPHYADDR? */
    728 static int
    729 gif_ioctl(struct ifnet *ifp, u_long cmd, void *data)
    730 {
    731 	struct gif_softc *sc  = ifp->if_softc;
    732 	struct ifreq     *ifr = (struct ifreq*)data;
    733 	struct ifaddr    *ifa = (struct ifaddr*)data;
    734 	int error = 0, size, bound;
    735 	struct sockaddr *dst, *src;
    736 	struct gif_variant *var;
    737 	struct psref psref;
    738 
    739 	switch (cmd) {
    740 	case SIOCINITIFADDR:
    741 		ifp->if_flags |= IFF_UP;
    742 		ifa->ifa_rtrequest = p2p_rtrequest;
    743 		break;
    744 
    745 	case SIOCADDMULTI:
    746 	case SIOCDELMULTI:
    747 		switch (ifr->ifr_addr.sa_family) {
    748 #ifdef INET
    749 		case AF_INET:	/* IP supports Multicast */
    750 			break;
    751 #endif /* INET */
    752 #ifdef INET6
    753 		case AF_INET6:	/* IP6 supports Multicast */
    754 			break;
    755 #endif /* INET6 */
    756 		default:  /* Other protocols doesn't support Multicast */
    757 			error = EAFNOSUPPORT;
    758 			break;
    759 		}
    760 		break;
    761 
    762 	case SIOCSIFMTU:
    763 		if (ifr->ifr_mtu < GIF_MTU_MIN || ifr->ifr_mtu > GIF_MTU_MAX)
    764 			return EINVAL;
    765 		else if ((error = ifioctl_common(ifp, cmd, data)) == ENETRESET)
    766 			error = 0;
    767 		break;
    768 
    769 #ifdef INET
    770 	case SIOCSIFPHYADDR:
    771 #endif
    772 #ifdef INET6
    773 	case SIOCSIFPHYADDR_IN6:
    774 #endif /* INET6 */
    775 	case SIOCSLIFPHYADDR:
    776 		switch (cmd) {
    777 #ifdef INET
    778 		case SIOCSIFPHYADDR:
    779 			src = (struct sockaddr *)
    780 				&(((struct in_aliasreq *)data)->ifra_addr);
    781 			dst = (struct sockaddr *)
    782 				&(((struct in_aliasreq *)data)->ifra_dstaddr);
    783 			break;
    784 #endif
    785 #ifdef INET6
    786 		case SIOCSIFPHYADDR_IN6:
    787 			src = (struct sockaddr *)
    788 				&(((struct in6_aliasreq *)data)->ifra_addr);
    789 			dst = (struct sockaddr *)
    790 				&(((struct in6_aliasreq *)data)->ifra_dstaddr);
    791 			break;
    792 #endif
    793 		case SIOCSLIFPHYADDR:
    794 			src = (struct sockaddr *)
    795 				&(((struct if_laddrreq *)data)->addr);
    796 			dst = (struct sockaddr *)
    797 				&(((struct if_laddrreq *)data)->dstaddr);
    798 			break;
    799 		default:
    800 			return EINVAL;
    801 		}
    802 
    803 		/* sa_family must be equal */
    804 		if (src->sa_family != dst->sa_family)
    805 			return EINVAL;
    806 
    807 		/* validate sa_len */
    808 		switch (src->sa_family) {
    809 #ifdef INET
    810 		case AF_INET:
    811 			if (src->sa_len != sizeof(struct sockaddr_in))
    812 				return EINVAL;
    813 			break;
    814 #endif
    815 #ifdef INET6
    816 		case AF_INET6:
    817 			if (src->sa_len != sizeof(struct sockaddr_in6))
    818 				return EINVAL;
    819 			break;
    820 #endif
    821 		default:
    822 			return EAFNOSUPPORT;
    823 		}
    824 		switch (dst->sa_family) {
    825 #ifdef INET
    826 		case AF_INET:
    827 			if (dst->sa_len != sizeof(struct sockaddr_in))
    828 				return EINVAL;
    829 			break;
    830 #endif
    831 #ifdef INET6
    832 		case AF_INET6:
    833 			if (dst->sa_len != sizeof(struct sockaddr_in6))
    834 				return EINVAL;
    835 			break;
    836 #endif
    837 		default:
    838 			return EAFNOSUPPORT;
    839 		}
    840 
    841 		/* check sa_family looks sane for the cmd */
    842 		switch (cmd) {
    843 		case SIOCSIFPHYADDR:
    844 			if (src->sa_family == AF_INET)
    845 				break;
    846 			return EAFNOSUPPORT;
    847 #ifdef INET6
    848 		case SIOCSIFPHYADDR_IN6:
    849 			if (src->sa_family == AF_INET6)
    850 				break;
    851 			return EAFNOSUPPORT;
    852 #endif /* INET6 */
    853 		case SIOCSLIFPHYADDR:
    854 			/* checks done in the above */
    855 			break;
    856 		}
    857 		/*
    858 		 * calls gif_getref_variant() for other softcs to check
    859 		 * address pair duplicattion
    860 		 */
    861 		bound = curlwp_bind();
    862 		error = gif_set_tunnel(&sc->gif_if, src, dst);
    863 		curlwp_bindx(bound);
    864 		break;
    865 
    866 #ifdef SIOCDIFPHYADDR
    867 	case SIOCDIFPHYADDR:
    868 		bound = curlwp_bind();
    869 		gif_delete_tunnel(&sc->gif_if);
    870 		curlwp_bindx(bound);
    871 		break;
    872 #endif
    873 
    874 	case SIOCGIFPSRCADDR:
    875 #ifdef INET6
    876 	case SIOCGIFPSRCADDR_IN6:
    877 #endif /* INET6 */
    878 		bound = curlwp_bind();
    879 		var = gif_getref_variant(sc, &psref);
    880 		if (var->gv_psrc == NULL) {
    881 			gif_putref_variant(var, &psref);
    882 			curlwp_bindx(bound);
    883 			error = EADDRNOTAVAIL;
    884 			goto bad;
    885 		}
    886 		src = var->gv_psrc;
    887 		switch (cmd) {
    888 #ifdef INET
    889 		case SIOCGIFPSRCADDR:
    890 			dst = &ifr->ifr_addr;
    891 			size = sizeof(ifr->ifr_addr);
    892 			break;
    893 #endif /* INET */
    894 #ifdef INET6
    895 		case SIOCGIFPSRCADDR_IN6:
    896 			dst = (struct sockaddr *)
    897 				&(((struct in6_ifreq *)data)->ifr_addr);
    898 			size = sizeof(((struct in6_ifreq *)data)->ifr_addr);
    899 			break;
    900 #endif /* INET6 */
    901 		default:
    902 			gif_putref_variant(var, &psref);
    903 			curlwp_bindx(bound);
    904 			error = EADDRNOTAVAIL;
    905 			goto bad;
    906 		}
    907 		if (src->sa_len > size) {
    908 			gif_putref_variant(var, &psref);
    909 			curlwp_bindx(bound);
    910 			return EINVAL;
    911 		}
    912 		memcpy(dst, src, src->sa_len);
    913 		gif_putref_variant(var, &psref);
    914 		curlwp_bindx(bound);
    915 		break;
    916 
    917 	case SIOCGIFPDSTADDR:
    918 #ifdef INET6
    919 	case SIOCGIFPDSTADDR_IN6:
    920 #endif /* INET6 */
    921 		bound = curlwp_bind();
    922 		var = gif_getref_variant(sc, &psref);
    923 		if (var->gv_pdst == NULL) {
    924 			gif_putref_variant(var, &psref);
    925 			curlwp_bindx(bound);
    926 			error = EADDRNOTAVAIL;
    927 			goto bad;
    928 		}
    929 		src = var->gv_pdst;
    930 		switch (cmd) {
    931 #ifdef INET
    932 		case SIOCGIFPDSTADDR:
    933 			dst = &ifr->ifr_addr;
    934 			size = sizeof(ifr->ifr_addr);
    935 			break;
    936 #endif /* INET */
    937 #ifdef INET6
    938 		case SIOCGIFPDSTADDR_IN6:
    939 			dst = (struct sockaddr *)
    940 				&(((struct in6_ifreq *)data)->ifr_addr);
    941 			size = sizeof(((struct in6_ifreq *)data)->ifr_addr);
    942 			break;
    943 #endif /* INET6 */
    944 		default:
    945 			gif_putref_variant(var, &psref);
    946 			curlwp_bindx(bound);
    947 			error = EADDRNOTAVAIL;
    948 			goto bad;
    949 		}
    950 		if (src->sa_len > size) {
    951 			gif_putref_variant(var, &psref);
    952 			curlwp_bindx(bound);
    953 			return EINVAL;
    954 		}
    955 		memcpy(dst, src, src->sa_len);
    956 		gif_putref_variant(var, &psref);
    957 		curlwp_bindx(bound);
    958 		break;
    959 
    960 	case SIOCGLIFPHYADDR:
    961 		bound = curlwp_bind();
    962 		var = gif_getref_variant(sc, &psref);
    963 		if (var->gv_psrc == NULL || var->gv_pdst == NULL) {
    964 			gif_putref_variant(var, &psref);
    965 			curlwp_bindx(bound);
    966 			error = EADDRNOTAVAIL;
    967 			goto bad;
    968 		}
    969 
    970 		/* copy src */
    971 		src = var->gv_psrc;
    972 		dst = (struct sockaddr *)
    973 			&(((struct if_laddrreq *)data)->addr);
    974 		size = sizeof(((struct if_laddrreq *)data)->addr);
    975 		if (src->sa_len > size) {
    976 			gif_putref_variant(var, &psref);
    977 			curlwp_bindx(bound);
    978 			return EINVAL;
    979 		}
    980 		memcpy(dst, src, src->sa_len);
    981 
    982 		/* copy dst */
    983 		src = var->gv_pdst;
    984 		dst = (struct sockaddr *)
    985 			&(((struct if_laddrreq *)data)->dstaddr);
    986 		size = sizeof(((struct if_laddrreq *)data)->dstaddr);
    987 		if (src->sa_len > size) {
    988 			gif_putref_variant(var, &psref);
    989 			curlwp_bindx(bound);
    990 			return EINVAL;
    991 		}
    992 		memcpy(dst, src, src->sa_len);
    993 		gif_putref_variant(var, &psref);
    994 		curlwp_bindx(bound);
    995 		break;
    996 
    997 	default:
    998 		return ifioctl_common(ifp, cmd, data);
    999 	}
   1000  bad:
   1001 	return error;
   1002 }
   1003 
   1004 static int
   1005 gif_encap_attach(struct gif_variant *var)
   1006 {
   1007 	int error;
   1008 
   1009 	if (var == NULL || var->gv_psrc == NULL)
   1010 		return EINVAL;
   1011 
   1012 	switch (var->gv_psrc->sa_family) {
   1013 #ifdef INET
   1014 	case AF_INET:
   1015 		error = in_gif_attach(var);
   1016 		break;
   1017 #endif
   1018 #ifdef INET6
   1019 	case AF_INET6:
   1020 		error = in6_gif_attach(var);
   1021 		break;
   1022 #endif
   1023 	default:
   1024 		error = EINVAL;
   1025 		break;
   1026 	}
   1027 
   1028 	return error;
   1029 }
   1030 
   1031 static int
   1032 gif_encap_detach(struct gif_variant *var)
   1033 {
   1034 	int error;
   1035 
   1036 	if (var == NULL || var->gv_psrc == NULL)
   1037 		return EINVAL;
   1038 
   1039 	switch (var->gv_psrc->sa_family) {
   1040 #ifdef INET
   1041 	case AF_INET:
   1042 		error = in_gif_detach(var);
   1043 		break;
   1044 #endif
   1045 #ifdef INET6
   1046 	case AF_INET6:
   1047 		error = in6_gif_detach(var);
   1048 		break;
   1049 #endif
   1050 	default:
   1051 		error = EINVAL;
   1052 		break;
   1053 	}
   1054 
   1055 	return error;
   1056 }
   1057 
   1058 static int
   1059 gif_set_tunnel(struct ifnet *ifp, struct sockaddr *src, struct sockaddr *dst)
   1060 {
   1061 	struct gif_softc *sc = ifp->if_softc;
   1062 	struct gif_softc *sc2;
   1063 	struct gif_variant *ovar, *nvar;
   1064 	struct sockaddr *osrc, *odst;
   1065 	struct sockaddr *nsrc, *ndst;
   1066 	int error;
   1067 #ifndef GIF_MPSAFE
   1068 	int s;
   1069 
   1070 	s = splsoftnet();
   1071 #endif
   1072 	error = encap_lock_enter();
   1073 	if (error) {
   1074 #ifndef GIF_MPSAFE
   1075 		splx(s);
   1076 #endif
   1077 		return error;
   1078 	}
   1079 
   1080 	nsrc = sockaddr_dup(src, M_WAITOK);
   1081 	ndst = sockaddr_dup(dst, M_WAITOK);
   1082 	nvar = kmem_alloc(sizeof(*nvar), KM_SLEEP);
   1083 
   1084 	mutex_enter(&sc->gif_lock);
   1085 
   1086 	ovar = sc->gif_var;
   1087 
   1088 	if ((ovar->gv_pdst && sockaddr_cmp(ovar->gv_pdst, dst) == 0) &&
   1089 	    (ovar->gv_psrc && sockaddr_cmp(ovar->gv_psrc, src) == 0)) {
   1090 		/* address and port pair not changed. */
   1091 		error = 0;
   1092 		goto out;
   1093 	}
   1094 
   1095 	mutex_enter(&gif_softcs.lock);
   1096 	LIST_FOREACH(sc2, &gif_softcs.list, gif_list) {
   1097 		struct gif_variant *var2;
   1098 		struct psref psref;
   1099 
   1100 		if (sc2 == sc)
   1101 			continue;
   1102 		var2 = gif_getref_variant(sc2, &psref);
   1103 		if (!var2->gv_pdst || !var2->gv_psrc) {
   1104 			gif_putref_variant(var2, &psref);
   1105 			continue;
   1106 		}
   1107 		/* can't configure same pair of address onto two gifs */
   1108 		if (sockaddr_cmp(var2->gv_pdst, dst) == 0 &&
   1109 		    sockaddr_cmp(var2->gv_psrc, src) == 0) {
   1110 			/* continue to use the old configuration. */
   1111 			gif_putref_variant(var2, &psref);
   1112 			mutex_exit(&gif_softcs.lock);
   1113 			error =  EADDRNOTAVAIL;
   1114 			goto out;
   1115 		}
   1116 		gif_putref_variant(var2, &psref);
   1117 		/* XXX both end must be valid? (I mean, not 0.0.0.0) */
   1118 	}
   1119 	mutex_exit(&gif_softcs.lock);
   1120 
   1121 	osrc = ovar->gv_psrc;
   1122 	odst = ovar->gv_pdst;
   1123 
   1124 	*nvar = *ovar;
   1125 	nvar->gv_psrc = nsrc;
   1126 	nvar->gv_pdst = ndst;
   1127 	nvar->gv_encap_cookie4 = NULL;
   1128 	nvar->gv_encap_cookie6 = NULL;
   1129 	error = gif_encap_attach(nvar);
   1130 	if (error)
   1131 		goto out;
   1132 	psref_target_init(&nvar->gv_psref, gv_psref_class);
   1133 	membar_producer();
   1134 	gif_update_variant(sc, nvar);
   1135 
   1136 	mutex_exit(&sc->gif_lock);
   1137 
   1138 	(void)gif_encap_detach(ovar);
   1139 	encap_lock_exit();
   1140 
   1141 	if (osrc)
   1142 		sockaddr_free(osrc);
   1143 	if (odst)
   1144 		sockaddr_free(odst);
   1145 	kmem_free(ovar, sizeof(*ovar));
   1146 
   1147 #ifndef GIF_MPSAFE
   1148 	splx(s);
   1149 #endif
   1150 	return 0;
   1151 
   1152  out:
   1153 	sockaddr_free(nsrc);
   1154 	sockaddr_free(ndst);
   1155 	kmem_free(nvar, sizeof(*nvar));
   1156 
   1157 	mutex_exit(&sc->gif_lock);
   1158 	encap_lock_exit();
   1159 #ifndef GIF_MPSAFE
   1160 	splx(s);
   1161 #endif
   1162 	return error;
   1163 }
   1164 
   1165 static void
   1166 gif_delete_tunnel(struct ifnet *ifp)
   1167 {
   1168 	struct gif_softc *sc = ifp->if_softc;
   1169 	struct gif_variant *ovar, *nvar;
   1170 	struct sockaddr *osrc, *odst;
   1171 	int error;
   1172 #ifndef GIF_MPSAFE
   1173 	int s;
   1174 
   1175 	s = splsoftnet();
   1176 #endif
   1177 	error = encap_lock_enter();
   1178 	if (error) {
   1179 #ifndef GIF_MPSAFE
   1180 		splx(s);
   1181 #endif
   1182 		return;
   1183 	}
   1184 
   1185 	nvar = kmem_alloc(sizeof(*nvar), KM_SLEEP);
   1186 
   1187 	mutex_enter(&sc->gif_lock);
   1188 
   1189 	ovar = sc->gif_var;
   1190 	osrc = ovar->gv_psrc;
   1191 	odst = ovar->gv_pdst;
   1192 	if (osrc == NULL || odst == NULL) {
   1193 		/* address pair not changed. */
   1194 		mutex_exit(&sc->gif_lock);
   1195 		encap_lock_exit();
   1196 		kmem_free(nvar, sizeof(*nvar));
   1197 #ifndef GIF_MPSAFE
   1198 		splx(s);
   1199 #endif
   1200 		return;
   1201 	}
   1202 
   1203 	*nvar = *ovar;
   1204 	nvar->gv_psrc = NULL;
   1205 	nvar->gv_pdst = NULL;
   1206 	nvar->gv_encap_cookie4 = NULL;
   1207 	nvar->gv_encap_cookie6 = NULL;
   1208 	nvar->gv_output = NULL;
   1209 	psref_target_init(&nvar->gv_psref, gv_psref_class);
   1210 	membar_producer();
   1211 	gif_update_variant(sc, nvar);
   1212 
   1213 	mutex_exit(&sc->gif_lock);
   1214 
   1215 	gif_encap_detach(ovar);
   1216 	encap_lock_exit();
   1217 
   1218 	sockaddr_free(osrc);
   1219 	sockaddr_free(odst);
   1220 	kmem_free(ovar, sizeof(*ovar));
   1221 
   1222 #ifndef GIF_MPSAFE
   1223 	splx(s);
   1224 #endif
   1225 }
   1226 
   1227 /*
   1228  * gif_variant update API.
   1229  *
   1230  * Assumption:
   1231  * reader side dereferences sc->gif_var in reader critical section only,
   1232  * that is, all of reader sides do not reader the sc->gif_var after
   1233  * pserialize_perform().
   1234  */
   1235 static void
   1236 gif_update_variant(struct gif_softc *sc, struct gif_variant *nvar)
   1237 {
   1238 	struct ifnet *ifp = &sc->gif_if;
   1239 	struct gif_variant *ovar = sc->gif_var;
   1240 
   1241 	KASSERT(mutex_owned(&sc->gif_lock));
   1242 
   1243 	sc->gif_var = nvar;
   1244 	pserialize_perform(sc->gif_psz);
   1245 	psref_target_destroy(&ovar->gv_psref, gv_psref_class);
   1246 
   1247 	if (nvar->gv_psrc != NULL && nvar->gv_pdst != NULL)
   1248 		ifp->if_flags |= IFF_RUNNING;
   1249 	else
   1250 		ifp->if_flags &= ~IFF_RUNNING;
   1251 }
   1252 
   1253 /*
   1254  * Module infrastructure
   1255  */
   1256 #include "if_module.h"
   1257 
   1258 IF_MODULE(MODULE_CLASS_DRIVER, gif, "ip_ecn")
   1259