sys/net/if_loop.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)if_loop.c   8.2 (Berkeley) 1/9/95
  32  */
  33
  34 /*
  35  * Loopback interface driver for protocol testing and timing.
  36  */
  37
  38 #include "opt_inet.h"
  39 #include "opt_inet6.h"
  40 #include "opt_rss.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/kernel.h>
  45 #include <sys/mbuf.h>
  46 #include <sys/module.h>
  47 #include <machine/bus.h>
  48 #include <sys/rman.h>
  49 #include <sys/socket.h>
  50 #include <sys/sockio.h>
  51 #include <sys/sysctl.h>
  52
  53 #include <net/if.h>
  54 #include <net/if_var.h>
  55 #include <net/if_clone.h>
  56 #include <net/if_types.h>
  57 #include <net/netisr.h>
  58 #include <net/route.h>
  59 #include <net/bpf.h>
  60 #include <net/vnet.h>
  61
  62 #ifdef  INET
  63 #include <netinet/in.h>
  64 #include <netinet/in_var.h>
  65 #endif
  66
  67 #ifdef INET6
  68 #ifndef INET
  69 #include <netinet/in.h>
  70 #endif
  71 #include <netinet6/in6_var.h>
  72 #include <netinet/ip6.h>
  73 #endif
  74
  75 #include <security/mac/mac_framework.h>
  76
  77 #ifdef TINY_LOMTU
  78 #define LOMTU   (1024+512)
  79 #elif defined(LARGE_LOMTU)
  80 #define LOMTU   131072
  81 #else
  82 #define LOMTU   16384
  83 #endif
  84
  85 #define LO_CSUM_FEATURES        (CSUM_IP | CSUM_TCP | CSUM_UDP | CSUM_SCTP)
  86 #define LO_CSUM_FEATURES6       (CSUM_TCP_IPV6 | CSUM_UDP_IPV6 | CSUM_SCTP_IPV6)
  87 #define LO_CSUM_SET             (CSUM_DATA_VALID | CSUM_DATA_VALID_IPV6 | \
  88                                     CSUM_PSEUDO_HDR | \
  89                                     CSUM_IP_CHECKED | CSUM_IP_VALID | \
  90                                     CSUM_SCTP_VALID)
  91
  92 int             loioctl(struct ifnet *, u_long, caddr_t);
  93 int             looutput(struct ifnet *ifp, struct mbuf *m,
  94                     const struct sockaddr *dst, struct route *ro);
  95 static int      lo_clone_create(struct if_clone *, int, caddr_t);
  96 static void     lo_clone_destroy(struct ifnet *);
  97
  98 VNET_DEFINE(struct ifnet *, loif);      /* Used externally */
  99
 100 #ifdef VIMAGE
 101 VNET_DEFINE_STATIC(struct if_clone *, lo_cloner);
 102 #define V_lo_cloner             VNET(lo_cloner)
 103 #endif
 104
 105 static struct if_clone *lo_cloner;
 106 static const char loname[] = "lo";
 107
 108 static void
 109 lo_clone_destroy(struct ifnet *ifp)
 110 {
 111
 112 #ifndef VIMAGE
 113         /* XXX: destroying lo0 will lead to panics. */
 114         KASSERT(V_loif != ifp, ("%s: destroying lo0", __func__));
 115 #endif
 116
 117         bpfdetach(ifp);
 118         if_detach(ifp);
 119         if_free(ifp);
 120 }
 121
 122 static int
 123 lo_clone_create(struct if_clone *ifc, int unit, caddr_t params)
 124 {
 125         struct ifnet *ifp;
 126
 127         ifp = if_alloc(IFT_LOOP);
 128         if (ifp == NULL)
 129                 return (ENOSPC);
 130
 131         if_initname(ifp, loname, unit);
 132         ifp->if_mtu = LOMTU;
 133         ifp->if_flags = IFF_LOOPBACK | IFF_MULTICAST;
 134         ifp->if_ioctl = loioctl;
 135         ifp->if_output = looutput;
 136         ifp->if_snd.ifq_maxlen = ifqmaxlen;
 137         ifp->if_capabilities = ifp->if_capenable =
 138             IFCAP_HWCSUM | IFCAP_HWCSUM_IPV6 | IFCAP_LINKSTATE;
 139         ifp->if_hwassist = LO_CSUM_FEATURES | LO_CSUM_FEATURES6;
 140         if_attach(ifp);
 141         bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
 142         if (V_loif == NULL)
 143                 V_loif = ifp;
 144
 145         return (0);
 146 }
 147
 148 static void
 149 vnet_loif_init(const void *unused __unused)
 150 {
 151
 152 #ifdef VIMAGE
 153         lo_cloner = if_clone_simple(loname, lo_clone_create, lo_clone_destroy,
 154             1);
 155         V_lo_cloner = lo_cloner;
 156 #else
 157         lo_cloner = if_clone_simple(loname, lo_clone_create, lo_clone_destroy,
 158             1);
 159 #endif
 160 }
 161 VNET_SYSINIT(vnet_loif_init, SI_SUB_PSEUDO, SI_ORDER_ANY,
 162     vnet_loif_init, NULL);
 163
 164 #ifdef VIMAGE
 165 static void
 166 vnet_loif_uninit(const void *unused __unused)
 167 {
 168
 169         if_clone_detach(V_lo_cloner);
 170         V_loif = NULL;
 171 }
 172 VNET_SYSUNINIT(vnet_loif_uninit, SI_SUB_INIT_IF, SI_ORDER_SECOND,
 173     vnet_loif_uninit, NULL);
 174 #endif
 175
 176 static int
 177 loop_modevent(module_t mod, int type, void *data)
 178 {
 179
 180         switch (type) {
 181         case MOD_LOAD:
 182                 break;
 183
 184         case MOD_UNLOAD:
 185                 printf("loop module unload - not possible for this module type\n");
 186                 return (EINVAL);
 187
 188         default:
 189                 return (EOPNOTSUPP);
 190         }
 191         return (0);
 192 }
 193
 194 static moduledata_t loop_mod = {
 195         "if_lo",
 196         loop_modevent,
 197         0
 198 };
 199
 200 DECLARE_MODULE(if_lo, loop_mod, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_ANY);
 201
 202 int
 203 looutput(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst,
 204     struct route *ro)
 205 {
 206         u_int32_t af;
 207 #ifdef MAC
 208         int error;
 209 #endif
 210
 211         M_ASSERTPKTHDR(m); /* check if we have the packet header */
 212
 213 #ifdef MAC
 214         error = mac_ifnet_check_transmit(ifp, m);
 215         if (error) {
 216                 m_freem(m);
 217                 return (error);
 218         }
 219 #endif
 220
 221         if (ro != NULL && ro->ro_flags & (RT_REJECT|RT_BLACKHOLE)) {
 222                 m_freem(m);
 223                 return (ro->ro_flags & RT_BLACKHOLE ? 0 : EHOSTUNREACH);
 224         }
 225
 226         if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
 227         if_inc_counter(ifp, IFCOUNTER_OBYTES, m->m_pkthdr.len);
 228
 229 #ifdef RSS
 230         M_HASHTYPE_CLEAR(m);
 231 #endif
 232
 233         /* BPF writes need to be handled specially. */
 234         if (dst->sa_family == AF_UNSPEC || dst->sa_family == pseudo_AF_HDRCMPLT)
 235                 bcopy(dst->sa_data, &af, sizeof(af));
 236         else
 237                 af = RO_GET_FAMILY(ro, dst);
 238
 239 #if 1   /* XXX */
 240         switch (af) {
 241         case AF_INET:
 242                 if (ifp->if_capenable & IFCAP_RXCSUM) {
 243                         m->m_pkthdr.csum_data = 0xffff;
 244                         m->m_pkthdr.csum_flags = LO_CSUM_SET;
 245                 }
 246                 m->m_pkthdr.csum_flags &= ~LO_CSUM_FEATURES;
 247                 break;
 248         case AF_INET6:
 249 #if 0
 250                 /*
 251                  * XXX-BZ for now always claim the checksum is good despite
 252                  * any interface flags.   This is a workaround for 9.1-R and
 253                  * a proper solution ought to be sought later.
 254                  */
 255                 if (ifp->if_capenable & IFCAP_RXCSUM_IPV6) {
 256                         m->m_pkthdr.csum_data = 0xffff;
 257                         m->m_pkthdr.csum_flags = LO_CSUM_SET;
 258                 }
 259 #else
 260                 m->m_pkthdr.csum_data = 0xffff;
 261                 m->m_pkthdr.csum_flags = LO_CSUM_SET;
 262 #endif
 263                 m->m_pkthdr.csum_flags &= ~LO_CSUM_FEATURES6;
 264                 break;
 265         default:
 266                 printf("looutput: af=%d unexpected\n", af);
 267                 m_freem(m);
 268                 return (EAFNOSUPPORT);
 269         }
 270 #endif
 271         return (if_simloop(ifp, m, af, 0));
 272 }
 273
 274 /*
 275  * if_simloop()
 276  *
 277  * This function is to support software emulation of hardware loopback,
 278  * i.e., for interfaces with the IFF_SIMPLEX attribute. Since they can't
 279  * hear their own broadcasts, we create a copy of the packet that we
 280  * would normally receive via a hardware loopback.
 281  *
 282  * This function expects the packet to include the media header of length hlen.
 283  */
 284 int
 285 if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen)
 286 {
 287         int isr;
 288
 289         M_ASSERTPKTHDR(m);
 290         m_tag_delete_nonpersistent(m);
 291         m->m_pkthdr.rcvif = ifp;
 292
 293 #ifdef MAC
 294         mac_ifnet_create_mbuf(ifp, m);
 295 #endif
 296
 297         /*
 298          * Let BPF see incoming packet in the following manner:
 299          *  - Emulated packet loopback for a simplex interface
 300          *    (net/if_ethersubr.c)
 301          *      -> passes it to ifp's BPF
 302          *  - IPv4/v6 multicast packet loopback (netinet(6)/ip(6)_output.c)
 303          *      -> not passes it to any BPF
 304          *  - Normal packet loopback from myself to myself (net/if_loop.c)
 305          *      -> passes to lo0's BPF (even in case of IPv6, where ifp!=lo0)
 306          */
 307         if (hlen > 0) {
 308                 if (bpf_peers_present(ifp->if_bpf)) {
 309                         bpf_mtap(ifp->if_bpf, m);
 310                 }
 311         } else {
 312                 if (bpf_peers_present(V_loif->if_bpf)) {
 313                         if ((m->m_flags & M_MCAST) == 0 || V_loif == ifp) {
 314                                 /* XXX beware sizeof(af) != 4 */
 315                                 u_int32_t af1 = af;
 316
 317                                 /*
 318                                  * We need to prepend the address family.
 319                                  */
 320                                 bpf_mtap2(V_loif->if_bpf, &af1, sizeof(af1), m);
 321                         }
 322                 }
 323         }
 324
 325         /* Strip away media header */
 326         if (hlen > 0) {
 327                 m_adj(m, hlen);
 328 #ifndef __NO_STRICT_ALIGNMENT
 329                 /*
 330                  * Some archs do not like unaligned data, so
 331                  * we move data down in the first mbuf.
 332                  */
 333                 if (mtod(m, vm_offset_t) & 3) {
 334                         KASSERT(hlen >= 3, ("if_simloop: hlen too small"));
 335                         bcopy(m->m_data,
 336                             (char *)(mtod(m, vm_offset_t)
 337                                 - (mtod(m, vm_offset_t) & 3)),
 338                             m->m_len);
 339                         m->m_data -= (mtod(m,vm_offset_t) & 3);
 340                 }
 341 #endif
 342         }
 343
 344         /* Deliver to upper layer protocol */
 345         switch (af) {
 346 #ifdef INET
 347         case AF_INET:
 348                 isr = NETISR_IP;
 349                 break;
 350 #endif
 351 #ifdef INET6
 352         case AF_INET6:
 353                 m->m_flags |= M_LOOP;
 354                 isr = NETISR_IPV6;
 355                 break;
 356 #endif
 357         default:
 358                 printf("if_simloop: can't handle af=%d\n", af);
 359                 m_freem(m);
 360                 return (EAFNOSUPPORT);
 361         }
 362         if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
 363         if_inc_counter(ifp, IFCOUNTER_IBYTES, m->m_pkthdr.len);
 364         netisr_queue(isr, m);   /* mbuf is free'd on failure. */
 365         return (0);
 366 }
 367
 368 /*
 369  * Process an ioctl request.
 370  */
 371 /* ARGSUSED */
 372 int
 373 loioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
 374 {
 375         struct ifreq *ifr = (struct ifreq *)data;
 376         int error = 0, mask;
 377
 378         switch (cmd) {
 379         case SIOCSIFADDR:
 380                 ifp->if_flags |= IFF_UP;
 381                 ifp->if_drv_flags |= IFF_DRV_RUNNING;
 382                 if_link_state_change(ifp, LINK_STATE_UP);
 383                 /*
 384                  * Everything else is done at a higher level.
 385                  */
 386                 break;
 387
 388         case SIOCADDMULTI:
 389         case SIOCDELMULTI:
 390                 if (ifr == NULL) {
 391                         error = EAFNOSUPPORT;           /* XXX */
 392                         break;
 393                 }
 394                 switch (ifr->ifr_addr.sa_family) {
 395 #ifdef INET
 396                 case AF_INET:
 397                         break;
 398 #endif
 399 #ifdef INET6
 400                 case AF_INET6:
 401                         break;
 402 #endif
 403
 404                 default:
 405                         error = EAFNOSUPPORT;
 406                         break;
 407                 }
 408                 break;
 409
 410         case SIOCSIFMTU:
 411                 ifp->if_mtu = ifr->ifr_mtu;
 412                 break;
 413
 414         case SIOCSIFFLAGS:
 415                 if_link_state_change(ifp, (ifp->if_flags & IFF_UP) ?
 416                     LINK_STATE_UP: LINK_STATE_DOWN);
 417                 break;
 418
 419         case SIOCSIFCAP:
 420                 mask = ifp->if_capenable ^ ifr->ifr_reqcap;
 421                 if ((mask & IFCAP_RXCSUM) != 0)
 422                         ifp->if_capenable ^= IFCAP_RXCSUM;
 423                 if ((mask & IFCAP_TXCSUM) != 0)
 424                         ifp->if_capenable ^= IFCAP_TXCSUM;
 425                 if ((mask & IFCAP_RXCSUM_IPV6) != 0) {
 426 #if 0
 427                         ifp->if_capenable ^= IFCAP_RXCSUM_IPV6;
 428 #else
 429                         error = EOPNOTSUPP;
 430                         break;
 431 #endif
 432                 }
 433                 if ((mask & IFCAP_TXCSUM_IPV6) != 0) {
 434 #if 0
 435                         ifp->if_capenable ^= IFCAP_TXCSUM_IPV6;
 436 #else
 437                         error = EOPNOTSUPP;
 438                         break;
 439 #endif
 440                 }
 441                 ifp->if_hwassist = 0;
 442                 if (ifp->if_capenable & IFCAP_TXCSUM)
 443                         ifp->if_hwassist = LO_CSUM_FEATURES;
 444 #if 0
 445                 if (ifp->if_capenable & IFCAP_TXCSUM_IPV6)
 446                         ifp->if_hwassist |= LO_CSUM_FEATURES6;
 447 #endif
 448                 break;
 449
 450         default:
 451                 error = EINVAL;
 452         }
 453         return (error);
 454 }