sys/netinet/ip_fastfwd.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2003 Andre Oppermann, Internet Business Solutions AG
   5  * 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. The name of the author may not be used to endorse or promote
  16  *    products derived from this software without specific prior written
  17  *    permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
  32 /*
  33  * ip_fastforward gets its speed from processing the forwarded packet to
  34  * completion (if_output on the other side) without any queues or netisr's.
  35  * The receiving interface DMAs the packet into memory, the upper half of
  36  * driver calls ip_fastforward, we do our routing table lookup and directly
  37  * send it off to the outgoing interface, which DMAs the packet to the
  38  * network card. The only part of the packet we touch with the CPU is the
  39  * IP header (unless there are complex firewall rules touching other parts
  40  * of the packet, but that is up to you). We are essentially limited by bus
  41  * bandwidth and how fast the network card/driver can set up receives and
  42  * transmits.
  43  *
  44  * We handle basic errors, IP header errors, checksum errors,
  45  * destination unreachable, fragmentation and fragmentation needed and
  46  * report them via ICMP to the sender.
  47  *
  48  * Else if something is not pure IPv4 unicast forwarding we fall back to
  49  * the normal ip_input processing path. We should only be called from
  50  * interfaces connected to the outside world.
  51  *
  52  * Firewalling is fully supported including divert, ipfw fwd and ipfilter
  53  * ipnat and address rewrite.
  54  *
  55  * IPSEC is not supported if this host is a tunnel broker. IPSEC is
  56  * supported for connections to/from local host.
  57  *
  58  * We try to do the least expensive (in CPU ops) checks and operations
  59  * first to catch junk with as little overhead as possible.
  60  *
  61  * We take full advantage of hardware support for IP checksum and
  62  * fragmentation offloading.
  63  *
  64  * We don't do ICMP redirect in the fast forwarding path. I have had my own
  65  * cases where two core routers with Zebra routing suite would send millions
  66  * ICMP redirects to connected hosts if the destination router was not the
  67  * default gateway. In one case it was filling the routing table of a host
  68  * with approximately 300.000 cloned redirect entries until it ran out of
  69  * kernel memory. However the networking code proved very robust and it didn't
  70  * crash or fail in other ways.
  71  */
  72
  73 /*
  74  * Many thanks to Matt Thomas of NetBSD for basic structure of ip_flow.c which
  75  * is being followed here.
  76  */
  77
  78 #include <sys/cdefs.h>
  79 __FBSDID("$FreeBSD$");
  80
  81 #include "opt_ipstealth.h"
  82
  83 #include <sys/param.h>
  84 #include <sys/systm.h>
  85 #include <sys/kernel.h>
  86 #include <sys/malloc.h>
  87 #include <sys/mbuf.h>
  88 #include <sys/protosw.h>
  89 #include <sys/sdt.h>
  90 #include <sys/socket.h>
  91 #include <sys/sysctl.h>
  92
  93 #include <net/if.h>
  94 #include <net/if_types.h>
  95 #include <net/if_var.h>
  96 #include <net/if_dl.h>
  97 #include <net/pfil.h>
  98 #include <net/route.h>
  99 #include <net/route/nhop.h>
 100 #include <net/vnet.h>
 101
 102 #include <netinet/in.h>
 103 #include <netinet/in_fib.h>
 104 #include <netinet/in_kdtrace.h>
 105 #include <netinet/in_systm.h>
 106 #include <netinet/in_var.h>
 107 #include <netinet/ip.h>
 108 #include <netinet/ip_var.h>
 109 #include <netinet/ip_icmp.h>
 110 #include <netinet/ip_options.h>
 111
 112 #include <machine/in_cksum.h>
 113
 114 #define V_ipsendredirects       VNET(ipsendredirects)
 115
 116 static struct mbuf *
 117 ip_redir_alloc(struct mbuf *m, struct nhop_object *nh,
 118     struct ip *ip, in_addr_t *addr)
 119 {
 120         struct mbuf *mcopy = m_gethdr(M_NOWAIT, m->m_type);
 121
 122         if (mcopy == NULL)
 123                 return (NULL);
 124
 125         if (m_dup_pkthdr(mcopy, m, M_NOWAIT) == 0) {
 126                 /*
 127                  * It's probably ok if the pkthdr dup fails (because
 128                  * the deep copy of the tag chain failed), but for now
 129                  * be conservative and just discard the copy since
 130                  * code below may some day want the tags.
 131                  */
 132                 m_free(mcopy);
 133                 return (NULL);
 134         }
 135         mcopy->m_len = min(ntohs(ip->ip_len), M_TRAILINGSPACE(mcopy));
 136         mcopy->m_pkthdr.len = mcopy->m_len;
 137         m_copydata(m, 0, mcopy->m_len, mtod(mcopy, caddr_t));
 138
 139         if (nh != NULL &&
 140             ((nh->nh_flags & (NHF_REDIRECT|NHF_DEFAULT)) == 0)) {
 141                 struct in_ifaddr *nh_ia = (struct in_ifaddr *)(nh->nh_ifa);
 142                 u_long src = ntohl(ip->ip_src.s_addr);
 143
 144                 if (nh_ia != NULL && (src & nh_ia->ia_subnetmask) == nh_ia->ia_subnet) {
 145                         if (nh->nh_flags & NHF_GATEWAY)
 146                                 *addr = nh->gw4_sa.sin_addr.s_addr;
 147                         else
 148                                 *addr = ip->ip_dst.s_addr;
 149                 }
 150         }
 151         return (mcopy);
 152 }
 153
 154
 155 static int
 156 ip_findroute(struct nhop_object **pnh, struct in_addr dest, struct mbuf *m)
 157 {
 158         struct nhop_object *nh;
 159
 160         nh = fib4_lookup(M_GETFIB(m), dest, 0, NHR_NONE,
 161             m->m_pkthdr.flowid);
 162         if (nh == NULL) {
 163                 IPSTAT_INC(ips_noroute);
 164                 IPSTAT_INC(ips_cantforward);
 165                 icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_HOST, 0, 0);
 166                 return (EHOSTUNREACH);
 167         }
 168         /*
 169          * Drop blackholed traffic and directed broadcasts.
 170          */
 171         if ((nh->nh_flags & (NHF_BLACKHOLE | NHF_BROADCAST)) != 0) {
 172                 IPSTAT_INC(ips_cantforward);
 173                 m_freem(m);
 174                 return (EHOSTUNREACH);
 175         }
 176
 177         if (nh->nh_flags & NHF_REJECT) {
 178                 IPSTAT_INC(ips_cantforward);
 179                 icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_HOST, 0, 0);
 180                 return (EHOSTUNREACH);
 181         }
 182
 183         *pnh = nh;
 184
 185         return (0);
 186 }
 187
 188 /*
 189  * Try to forward a packet based on the destination address.
 190  * This is a fast path optimized for the plain forwarding case.
 191  * If the packet is handled (and consumed) here then we return NULL;
 192  * otherwise mbuf is returned and the packet should be delivered
 193  * to ip_input for full processing.
 194  */
 195 struct mbuf *
 196 ip_tryforward(struct mbuf *m)
 197 {
 198         struct ip *ip;
 199         struct mbuf *m0 = NULL;
 200         struct nhop_object *nh = NULL;
 201         struct sockaddr_in dst;
 202         struct in_addr dest, odest, rtdest;
 203         uint16_t ip_len, ip_off;
 204         int error = 0;
 205         struct m_tag *fwd_tag = NULL;
 206         struct mbuf *mcopy = NULL;
 207         struct in_addr redest;
 208         /*
 209          * Are we active and forwarding packets?
 210          */
 211
 212         M_ASSERTVALID(m);
 213         M_ASSERTPKTHDR(m);
 214
 215 #ifdef ALTQ
 216         /*
 217          * Is packet dropped by traffic conditioner?
 218          */
 219         if (altq_input != NULL && (*altq_input)(m, AF_INET) == 0)
 220                 goto drop;
 221 #endif
 222
 223         /*
 224          * Only IP packets without options
 225          */
 226         ip = mtod(m, struct ip *);
 227
 228         if (ip->ip_hl != (sizeof(struct ip) >> 2)) {
 229                 if (V_ip_doopts == 1)
 230                         return m;
 231                 else if (V_ip_doopts == 2) {
 232                         icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_FILTER_PROHIB,
 233                                 0, 0);
 234                         return NULL;    /* mbuf already free'd */
 235                 }
 236                 /* else ignore IP options and continue */
 237         }
 238
 239         /*
 240          * Only unicast IP, not from loopback, no L2 or IP broadcast,
 241          * no multicast, no INADDR_ANY
 242          *
 243          * XXX: Probably some of these checks could be direct drop
 244          * conditions.  However it is not clear whether there are some
 245          * hacks or obscure behaviours which make it necessary to
 246          * let ip_input handle it.  We play safe here and let ip_input
 247          * deal with it until it is proven that we can directly drop it.
 248          */
 249         if ((m->m_flags & (M_BCAST|M_MCAST)) ||
 250             (m->m_pkthdr.rcvif->if_flags & IFF_LOOPBACK) ||
 251             ntohl(ip->ip_src.s_addr) == (u_long)INADDR_BROADCAST ||
 252             ntohl(ip->ip_dst.s_addr) == (u_long)INADDR_BROADCAST ||
 253             IN_MULTICAST(ntohl(ip->ip_src.s_addr)) ||
 254             IN_MULTICAST(ntohl(ip->ip_dst.s_addr)) ||
 255             IN_LINKLOCAL(ntohl(ip->ip_src.s_addr)) ||
 256             IN_LINKLOCAL(ntohl(ip->ip_dst.s_addr)) ||
 257             ip->ip_src.s_addr == INADDR_ANY ||
 258             ip->ip_dst.s_addr == INADDR_ANY )
 259                 return m;
 260
 261         /*
 262          * Is it for a local address on this host?
 263          */
 264         if (in_localip(ip->ip_dst))
 265                 return m;
 266
 267         IPSTAT_INC(ips_total);
 268
 269         /*
 270          * Step 3: incoming packet firewall processing
 271          */
 272
 273         odest.s_addr = dest.s_addr = ip->ip_dst.s_addr;
 274
 275         /*
 276          * Run through list of ipfilter hooks for input packets
 277          */
 278         if (!PFIL_HOOKED_IN(V_inet_pfil_head))
 279                 goto passin;
 280
 281         if (pfil_run_hooks(V_inet_pfil_head, &m, m->m_pkthdr.rcvif, PFIL_IN,
 282             NULL) != PFIL_PASS)
 283                 goto drop;
 284
 285         M_ASSERTVALID(m);
 286         M_ASSERTPKTHDR(m);
 287
 288         ip = mtod(m, struct ip *);      /* m may have changed by pfil hook */
 289         dest.s_addr = ip->ip_dst.s_addr;
 290
 291         /*
 292          * Destination address changed?
 293          */
 294         if (odest.s_addr != dest.s_addr) {
 295                 /*
 296                  * Is it now for a local address on this host?
 297                  */
 298                 if (in_localip(dest))
 299                         goto forwardlocal;
 300                 /*
 301                  * Go on with new destination address
 302                  */
 303         }
 304
 305         if (m->m_flags & M_FASTFWD_OURS) {
 306                 /*
 307                  * ipfw changed it for a local address on this host.
 308                  */
 309                 goto forwardlocal;
 310         }
 311
 312 passin:
 313         /*
 314          * Step 4: decrement TTL and look up route
 315          */
 316
 317         /*
 318          * Check TTL
 319          */
 320 #ifdef IPSTEALTH
 321         if (!V_ipstealth) {
 322 #endif
 323         if (ip->ip_ttl <= IPTTLDEC) {
 324                 icmp_error(m, ICMP_TIMXCEED, ICMP_TIMXCEED_INTRANS, 0, 0);
 325                 return NULL;    /* mbuf already free'd */
 326         }
 327
 328         /*
 329          * Decrement the TTL and incrementally change the IP header checksum.
 330          * Don't bother doing this with hw checksum offloading, it's faster
 331          * doing it right here.
 332          */
 333         ip->ip_ttl -= IPTTLDEC;
 334         if (ip->ip_sum >= (u_int16_t) ~htons(IPTTLDEC << 8))
 335                 ip->ip_sum -= ~htons(IPTTLDEC << 8);
 336         else
 337                 ip->ip_sum += htons(IPTTLDEC << 8);
 338 #ifdef IPSTEALTH
 339         }
 340 #endif
 341
 342         /*
 343          * Next hop forced by pfil(9) hook?
 344          */
 345         if ((m->m_flags & M_IP_NEXTHOP) &&
 346             ((fwd_tag = m_tag_find(m, PACKET_TAG_IPFORWARD, NULL)) != NULL)) {
 347                 /*
 348                  * Now we will find route to forced destination.
 349                  */
 350                 dest.s_addr = ((struct sockaddr_in *)
 351                             (fwd_tag + 1))->sin_addr.s_addr;
 352                 m_tag_delete(m, fwd_tag);
 353                 m->m_flags &= ~M_IP_NEXTHOP;
 354         }
 355
 356         /*
 357          * Find route to destination.
 358          */
 359         if (ip_findroute(&nh, dest, m) != 0)
 360                 return (NULL);  /* icmp unreach already sent */
 361
 362         /*
 363          * Avoid second route lookup by caching destination.
 364          */
 365         rtdest.s_addr = dest.s_addr;
 366
 367         /*
 368          * Step 5: outgoing firewall packet processing
 369          */
 370         if (!PFIL_HOOKED_OUT(V_inet_pfil_head))
 371                 goto passout;
 372
 373         if (pfil_run_hooks(V_inet_pfil_head, &m, nh->nh_ifp,
 374             PFIL_OUT | PFIL_FWD, NULL) != PFIL_PASS)
 375                 goto drop;
 376
 377         M_ASSERTVALID(m);
 378         M_ASSERTPKTHDR(m);
 379
 380         ip = mtod(m, struct ip *);
 381         dest.s_addr = ip->ip_dst.s_addr;
 382
 383         /*
 384          * Destination address changed?
 385          */
 386         if (m->m_flags & M_IP_NEXTHOP)
 387                 fwd_tag = m_tag_find(m, PACKET_TAG_IPFORWARD, NULL);
 388         else
 389                 fwd_tag = NULL;
 390         if (odest.s_addr != dest.s_addr || fwd_tag != NULL) {
 391                 /*
 392                  * Is it now for a local address on this host?
 393                  */
 394                 if (m->m_flags & M_FASTFWD_OURS || in_localip(dest)) {
 395 forwardlocal:
 396                         /*
 397                          * Return packet for processing by ip_input().
 398                          */
 399                         m->m_flags |= M_FASTFWD_OURS;
 400                         return (m);
 401                 }
 402                 /*
 403                  * Redo route lookup with new destination address
 404                  */
 405                 if (fwd_tag) {
 406                         dest.s_addr = ((struct sockaddr_in *)
 407                                     (fwd_tag + 1))->sin_addr.s_addr;
 408                         m_tag_delete(m, fwd_tag);
 409                         m->m_flags &= ~M_IP_NEXTHOP;
 410                 }
 411                 if (dest.s_addr != rtdest.s_addr &&
 412                     ip_findroute(&nh, dest, m) != 0)
 413                         return (NULL);  /* icmp unreach already sent */
 414         }
 415
 416 passout:
 417         /*
 418          * Step 6: send off the packet
 419          */
 420         ip_len = ntohs(ip->ip_len);
 421         ip_off = ntohs(ip->ip_off);
 422
 423         bzero(&dst, sizeof(dst));
 424         dst.sin_family = AF_INET;
 425         dst.sin_len = sizeof(dst);
 426         if (nh->nh_flags & NHF_GATEWAY)
 427                 dst.sin_addr = nh->gw4_sa.sin_addr;
 428         else
 429                 dst.sin_addr = dest;
 430
 431         /*
 432          * Handle redirect case.
 433          */
 434         redest.s_addr = 0;
 435         if (V_ipsendredirects && (nh->nh_ifp == m->m_pkthdr.rcvif))
 436                 mcopy = ip_redir_alloc(m, nh, ip, &redest.s_addr);
 437
 438         /*
 439          * Check if packet fits MTU or if hardware will fragment for us
 440          */
 441         if (ip_len <= nh->nh_mtu) {
 442                 /*
 443                  * Avoid confusing lower layers.
 444                  */
 445                 m_clrprotoflags(m);
 446                 /*
 447                  * Send off the packet via outgoing interface
 448                  */
 449                 IP_PROBE(send, NULL, NULL, ip, nh->nh_ifp, ip, NULL);
 450                 error = (*nh->nh_ifp->if_output)(nh->nh_ifp, m,
 451                     (struct sockaddr *)&dst, NULL);
 452         } else {
 453                 /*
 454                  * Handle EMSGSIZE with icmp reply needfrag for TCP MTU discovery
 455                  */
 456                 if (ip_off & IP_DF) {
 457                         IPSTAT_INC(ips_cantfrag);
 458                         icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_NEEDFRAG,
 459                                 0, nh->nh_mtu);
 460                         goto consumed;
 461                 } else {
 462                         /*
 463                          * We have to fragment the packet
 464                          */
 465                         m->m_pkthdr.csum_flags |= CSUM_IP;
 466                         if (ip_fragment(ip, &m, nh->nh_mtu,
 467                             nh->nh_ifp->if_hwassist) != 0)
 468                                 goto drop;
 469                         KASSERT(m != NULL, ("null mbuf and no error"));
 470                         /*
 471                          * Send off the fragments via outgoing interface
 472                          */
 473                         error = 0;
 474                         do {
 475                                 m0 = m->m_nextpkt;
 476                                 m->m_nextpkt = NULL;
 477                                 /*
 478                                  * Avoid confusing lower layers.
 479                                  */
 480                                 m_clrprotoflags(m);
 481
 482                                 IP_PROBE(send, NULL, NULL,
 483                                     mtod(m, struct ip *), nh->nh_ifp,
 484                                     mtod(m, struct ip *), NULL);
 485                                 error = (*nh->nh_ifp->if_output)(nh->nh_ifp, m,
 486                                     (struct sockaddr *)&dst, NULL);
 487                                 if (error)
 488                                         break;
 489                         } while ((m = m0) != NULL);
 490                         if (error) {
 491                                 /* Reclaim remaining fragments */
 492                                 for (m = m0; m; m = m0) {
 493                                         m0 = m->m_nextpkt;
 494                                         m_freem(m);
 495                                 }
 496                         } else
 497                                 IPSTAT_INC(ips_fragmented);
 498                 }
 499         }
 500
 501         if (error != 0)
 502                 IPSTAT_INC(ips_odropped);
 503         else {
 504                 IPSTAT_INC(ips_forward);
 505                 IPSTAT_INC(ips_fastforward);
 506         }
 507
 508         /* Send required redirect */
 509         if (mcopy != NULL) {
 510                 icmp_error(mcopy, ICMP_REDIRECT, ICMP_REDIRECT_HOST, redest.s_addr, 0);
 511                 mcopy = NULL; /* Freed by caller */
 512         }
 513
 514 consumed:
 515         if (mcopy != NULL)
 516                 m_freem(mcopy);
 517         return NULL;
 518 drop:
 519         if (m)
 520                 m_freem(m);
 521         return NULL;
 522 }