sys/netinet/ip_fastfwd.c

   1 /*-
   2  * Copyright (c) 2003 Andre Oppermann, Internet Business Solutions AG
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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. The name of the author may not be used to endorse or promote
  14  *    products derived from this software without specific prior written
  15  *    permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * ip_fastforward gets its speed from processing the forwarded packet to
  32  * completion (if_output on the other side) without any queues or netisr's.
  33  * The receiving interface DMAs the packet into memory, the upper half of
  34  * driver calls ip_fastforward, we do our routing table lookup and directly
  35  * send it off to the outgoing interface, which DMAs the packet to the
  36  * network card. The only part of the packet we touch with the CPU is the
  37  * IP header (unless there are complex firewall rules touching other parts
  38  * of the packet, but that is up to you). We are essentially limited by bus
  39  * bandwidth and how fast the network card/driver can set up receives and
  40  * transmits.
  41  *
  42  * We handle basic errors, IP header errors, checksum errors,
  43  * destination unreachable, fragmentation and fragmentation needed and
  44  * report them via ICMP to the sender.
  45  *
  46  * Else if something is not pure IPv4 unicast forwarding we fall back to
  47  * the normal ip_input processing path. We should only be called from
  48  * interfaces connected to the outside world.
  49  *
  50  * Firewalling is fully supported including divert, ipfw fwd and ipfilter
  51  * ipnat and address rewrite.
  52  *
  53  * IPSEC is not supported if this host is a tunnel broker. IPSEC is
  54  * supported for connections to/from local host.
  55  *
  56  * We try to do the least expensive (in CPU ops) checks and operations
  57  * first to catch junk with as little overhead as possible.
  58  *
  59  * We take full advantage of hardware support for IP checksum and
  60  * fragmentation offloading.
  61  *
  62  * We don't do ICMP redirect in the fast forwarding path. I have had my own
  63  * cases where two core routers with Zebra routing suite would send millions
  64  * ICMP redirects to connected hosts if the destination router was not the
  65  * default gateway. In one case it was filling the routing table of a host
  66  * with approximately 300.000 cloned redirect entries until it ran out of
  67  * kernel memory. However the networking code proved very robust and it didn't
  68  * crash or fail in other ways.
  69  */
  70
  71 /*
  72  * Many thanks to Matt Thomas of NetBSD for basic structure of ip_flow.c which
  73  * is being followed here.
  74  */
  75
  76 #include <sys/cdefs.h>
  77 __FBSDID("$FreeBSD$");
  78
  79 #include "opt_ipfw.h"
  80 #include "opt_ipstealth.h"
  81
  82 #include <sys/param.h>
  83 #include <sys/systm.h>
  84 #include <sys/kernel.h>
  85 #include <sys/malloc.h>
  86 #include <sys/mbuf.h>
  87 #include <sys/protosw.h>
  88 #include <sys/socket.h>
  89 #include <sys/sysctl.h>
  90
  91 #include <net/pfil.h>
  92 #include <net/if.h>
  93 #include <net/if_types.h>
  94 #include <net/if_var.h>
  95 #include <net/if_dl.h>
  96 #include <net/route.h>
  97 #include <net/vnet.h>
  98
  99 #include <netinet/in.h>
 100 #include <netinet/in_systm.h>
 101 #include <netinet/in_var.h>
 102 #include <netinet/ip.h>
 103 #include <netinet/ip_var.h>
 104 #include <netinet/ip_icmp.h>
 105 #include <netinet/ip_options.h>
 106
 107 #include <machine/in_cksum.h>
 108
 109 static VNET_DEFINE(int, ipfastforward_active);
 110 #define V_ipfastforward_active          VNET(ipfastforward_active)
 111
 112 SYSCTL_VNET_INT(_net_inet_ip, OID_AUTO, fastforwarding, CTLFLAG_RW,
 113     &VNET_NAME(ipfastforward_active), 0, "Enable fast IP forwarding");
 114
 115 static struct sockaddr_in *
 116 ip_findroute(struct route *ro, struct in_addr dest, struct mbuf *m)
 117 {
 118         struct sockaddr_in *dst;
 119         struct rtentry *rt;
 120
 121         /*
 122          * Find route to destination.
 123          */
 124         bzero(ro, sizeof(*ro));
 125         dst = (struct sockaddr_in *)&ro->ro_dst;
 126         dst->sin_family = AF_INET;
 127         dst->sin_len = sizeof(*dst);
 128         dst->sin_addr.s_addr = dest.s_addr;
 129         in_rtalloc_ign(ro, 0, M_GETFIB(m));
 130
 131         /*
 132          * Route there and interface still up?
 133          */
 134         rt = ro->ro_rt;
 135         if (rt && (rt->rt_flags & RTF_UP) &&
 136             (rt->rt_ifp->if_flags & IFF_UP) &&
 137             (rt->rt_ifp->if_drv_flags & IFF_DRV_RUNNING)) {
 138                 if (rt->rt_flags & RTF_GATEWAY)
 139                         dst = (struct sockaddr_in *)rt->rt_gateway;
 140         } else {
 141                 IPSTAT_INC(ips_noroute);
 142                 IPSTAT_INC(ips_cantforward);
 143                 if (rt)
 144                         RTFREE(rt);
 145                 icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_HOST, 0, 0);
 146                 return NULL;
 147         }
 148         return dst;
 149 }
 150
 151 /*
 152  * Try to forward a packet based on the destination address.
 153  * This is a fast path optimized for the plain forwarding case.
 154  * If the packet is handled (and consumed) here then we return NULL;
 155  * otherwise mbuf is returned and the packet should be delivered
 156  * to ip_input for full processing.
 157  */
 158 struct mbuf *
 159 ip_fastforward(struct mbuf *m)
 160 {
 161         struct ip *ip;
 162         struct mbuf *m0 = NULL;
 163         struct route ro;
 164         struct sockaddr_in *dst = NULL;
 165         struct ifnet *ifp;
 166         struct in_addr odest, dest;
 167         u_short sum, ip_len;
 168         int error = 0;
 169         int hlen, mtu;
 170         struct m_tag *fwd_tag = NULL;
 171
 172         /*
 173          * Are we active and forwarding packets?
 174          */
 175         if (!V_ipfastforward_active || !V_ipforwarding)
 176                 return m;
 177
 178         M_ASSERTVALID(m);
 179         M_ASSERTPKTHDR(m);
 180
 181         bzero(&ro, sizeof(ro));
 182
 183         /*
 184          * Step 1: check for packet drop conditions (and sanity checks)
 185          */
 186
 187         /*
 188          * Is entire packet big enough?
 189          */
 190         if (m->m_pkthdr.len < sizeof(struct ip)) {
 191                 IPSTAT_INC(ips_tooshort);
 192                 goto drop;
 193         }
 194
 195         /*
 196          * Is first mbuf large enough for ip header and is header present?
 197          */
 198         if (m->m_len < sizeof (struct ip) &&
 199            (m = m_pullup(m, sizeof (struct ip))) == NULL) {
 200                 IPSTAT_INC(ips_toosmall);
 201                 return NULL;    /* mbuf already free'd */
 202         }
 203
 204         ip = mtod(m, struct ip *);
 205
 206         /*
 207          * Is it IPv4?
 208          */
 209         if (ip->ip_v != IPVERSION) {
 210                 IPSTAT_INC(ips_badvers);
 211                 goto drop;
 212         }
 213
 214         /*
 215          * Is IP header length correct and is it in first mbuf?
 216          */
 217         hlen = ip->ip_hl << 2;
 218         if (hlen < sizeof(struct ip)) { /* minimum header length */
 219                 IPSTAT_INC(ips_badhlen);
 220                 goto drop;
 221         }
 222         if (hlen > m->m_len) {
 223                 if ((m = m_pullup(m, hlen)) == NULL) {
 224                         IPSTAT_INC(ips_badhlen);
 225                         return NULL;    /* mbuf already free'd */
 226                 }
 227                 ip = mtod(m, struct ip *);
 228         }
 229
 230         /*
 231          * Checksum correct?
 232          */
 233         if (m->m_pkthdr.csum_flags & CSUM_IP_CHECKED)
 234                 sum = !(m->m_pkthdr.csum_flags & CSUM_IP_VALID);
 235         else {
 236                 if (hlen == sizeof(struct ip))
 237                         sum = in_cksum_hdr(ip);
 238                 else
 239                         sum = in_cksum(m, hlen);
 240         }
 241         if (sum) {
 242                 IPSTAT_INC(ips_badsum);
 243                 goto drop;
 244         }
 245
 246         /*
 247          * Remember that we have checked the IP header and found it valid.
 248          */
 249         m->m_pkthdr.csum_flags |= (CSUM_IP_CHECKED | CSUM_IP_VALID);
 250
 251         ip_len = ntohs(ip->ip_len);
 252
 253         /*
 254          * Is IP length longer than packet we have got?
 255          */
 256         if (m->m_pkthdr.len < ip_len) {
 257                 IPSTAT_INC(ips_tooshort);
 258                 goto drop;
 259         }
 260
 261         /*
 262          * Is packet longer than IP header tells us? If yes, truncate packet.
 263          */
 264         if (m->m_pkthdr.len > ip_len) {
 265                 if (m->m_len == m->m_pkthdr.len) {
 266                         m->m_len = ip_len;
 267                         m->m_pkthdr.len = ip_len;
 268                 } else
 269                         m_adj(m, ip_len - m->m_pkthdr.len);
 270         }
 271
 272         /*
 273          * Is packet from or to 127/8?
 274          */
 275         if ((ntohl(ip->ip_dst.s_addr) >> IN_CLASSA_NSHIFT) == IN_LOOPBACKNET ||
 276             (ntohl(ip->ip_src.s_addr) >> IN_CLASSA_NSHIFT) == IN_LOOPBACKNET) {
 277                 IPSTAT_INC(ips_badaddr);
 278                 goto drop;
 279         }
 280
 281 #ifdef ALTQ
 282         /*
 283          * Is packet dropped by traffic conditioner?
 284          */
 285         if (altq_input != NULL && (*altq_input)(m, AF_INET) == 0)
 286                 goto drop;
 287 #endif
 288
 289         /*
 290          * Step 2: fallback conditions to normal ip_input path processing
 291          */
 292
 293         /*
 294          * Only IP packets without options
 295          */
 296         if (ip->ip_hl != (sizeof(struct ip) >> 2)) {
 297                 if (ip_doopts == 1)
 298                         return m;
 299                 else if (ip_doopts == 2) {
 300                         icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_FILTER_PROHIB,
 301                                 0, 0);
 302                         return NULL;    /* mbuf already free'd */
 303                 }
 304                 /* else ignore IP options and continue */
 305         }
 306
 307         /*
 308          * Only unicast IP, not from loopback, no L2 or IP broadcast,
 309          * no multicast, no INADDR_ANY
 310          *
 311          * XXX: Probably some of these checks could be direct drop
 312          * conditions.  However it is not clear whether there are some
 313          * hacks or obscure behaviours which make it neccessary to
 314          * let ip_input handle it.  We play safe here and let ip_input
 315          * deal with it until it is proven that we can directly drop it.
 316          */
 317         if ((m->m_flags & (M_BCAST|M_MCAST)) ||
 318             (m->m_pkthdr.rcvif->if_flags & IFF_LOOPBACK) ||
 319             ntohl(ip->ip_src.s_addr) == (u_long)INADDR_BROADCAST ||
 320             ntohl(ip->ip_dst.s_addr) == (u_long)INADDR_BROADCAST ||
 321             IN_MULTICAST(ntohl(ip->ip_src.s_addr)) ||
 322             IN_MULTICAST(ntohl(ip->ip_dst.s_addr)) ||
 323             IN_LINKLOCAL(ntohl(ip->ip_src.s_addr)) ||
 324             IN_LINKLOCAL(ntohl(ip->ip_dst.s_addr)) ||
 325             ip->ip_src.s_addr == INADDR_ANY ||
 326             ip->ip_dst.s_addr == INADDR_ANY )
 327                 return m;
 328
 329         /*
 330          * Is it for a local address on this host?
 331          */
 332         if (in_localip(ip->ip_dst))
 333                 return m;
 334
 335         IPSTAT_INC(ips_total);
 336
 337         /*
 338          * Step 3: incoming packet firewall processing
 339          */
 340
 341         /*
 342          * Convert to host representation
 343          */
 344         ip->ip_len = ntohs(ip->ip_len);
 345         ip->ip_off = ntohs(ip->ip_off);
 346
 347         odest.s_addr = dest.s_addr = ip->ip_dst.s_addr;
 348
 349         /*
 350          * Run through list of ipfilter hooks for input packets
 351          */
 352         if (!PFIL_HOOKED(&V_inet_pfil_hook))
 353                 goto passin;
 354
 355         if (pfil_run_hooks(
 356             &V_inet_pfil_hook, &m, m->m_pkthdr.rcvif, PFIL_IN, NULL) ||
 357             m == NULL)
 358                 goto drop;
 359
 360         M_ASSERTVALID(m);
 361         M_ASSERTPKTHDR(m);
 362
 363         ip = mtod(m, struct ip *);      /* m may have changed by pfil hook */
 364         dest.s_addr = ip->ip_dst.s_addr;
 365
 366         /*
 367          * Destination address changed?
 368          */
 369         if (odest.s_addr != dest.s_addr) {
 370                 /*
 371                  * Is it now for a local address on this host?
 372                  */
 373                 if (in_localip(dest))
 374                         goto forwardlocal;
 375                 /*
 376                  * Go on with new destination address
 377                  */
 378         }
 379
 380         if (m->m_flags & M_FASTFWD_OURS) {
 381                 /*
 382                  * ipfw changed it for a local address on this host.
 383                  */
 384                 goto forwardlocal;
 385         }
 386
 387 passin:
 388         /*
 389          * Step 4: decrement TTL and look up route
 390          */
 391
 392         /*
 393          * Check TTL
 394          */
 395 #ifdef IPSTEALTH
 396         if (!V_ipstealth) {
 397 #endif
 398         if (ip->ip_ttl <= IPTTLDEC) {
 399                 icmp_error(m, ICMP_TIMXCEED, ICMP_TIMXCEED_INTRANS, 0, 0);
 400                 return NULL;    /* mbuf already free'd */
 401         }
 402
 403         /*
 404          * Decrement the TTL and incrementally change the IP header checksum.
 405          * Don't bother doing this with hw checksum offloading, it's faster
 406          * doing it right here.
 407          */
 408         ip->ip_ttl -= IPTTLDEC;
 409         if (ip->ip_sum >= (u_int16_t) ~htons(IPTTLDEC << 8))
 410                 ip->ip_sum -= ~htons(IPTTLDEC << 8);
 411         else
 412                 ip->ip_sum += htons(IPTTLDEC << 8);
 413 #ifdef IPSTEALTH
 414         }
 415 #endif
 416
 417         /*
 418          * Find route to destination.
 419          */
 420         if ((dst = ip_findroute(&ro, dest, m)) == NULL)
 421                 return NULL;    /* icmp unreach already sent */
 422         ifp = ro.ro_rt->rt_ifp;
 423
 424         /*
 425          * Immediately drop blackholed traffic, and directed broadcasts
 426          * for either the all-ones or all-zero subnet addresses on
 427          * locally attached networks.
 428          */
 429         if ((ro.ro_rt->rt_flags & (RTF_BLACKHOLE|RTF_BROADCAST)) != 0)
 430                 goto drop;
 431
 432         /*
 433          * Step 5: outgoing firewall packet processing
 434          */
 435
 436         /*
 437          * Run through list of hooks for output packets.
 438          */
 439         if (!PFIL_HOOKED(&V_inet_pfil_hook))
 440                 goto passout;
 441
 442         if (pfil_run_hooks(&V_inet_pfil_hook, &m, ifp, PFIL_OUT, NULL) || m == NULL) {
 443                 goto drop;
 444         }
 445
 446         M_ASSERTVALID(m);
 447         M_ASSERTPKTHDR(m);
 448
 449         ip = mtod(m, struct ip *);
 450         dest.s_addr = ip->ip_dst.s_addr;
 451
 452         /*
 453          * Destination address changed?
 454          */
 455         if (m->m_flags & M_IP_NEXTHOP)
 456                 fwd_tag = m_tag_find(m, PACKET_TAG_IPFORWARD, NULL);
 457         if (odest.s_addr != dest.s_addr || fwd_tag != NULL) {
 458                 /*
 459                  * Is it now for a local address on this host?
 460                  */
 461                 if (m->m_flags & M_FASTFWD_OURS || in_localip(dest)) {
 462 forwardlocal:
 463                         /*
 464                          * Return packet for processing by ip_input().
 465                          * Keep host byte order as expected at ip_input's
 466                          * "ours"-label.
 467                          */
 468                         m->m_flags |= M_FASTFWD_OURS;
 469                         if (ro.ro_rt)
 470                                 RTFREE(ro.ro_rt);
 471                         return m;
 472                 }
 473                 /*
 474                  * Redo route lookup with new destination address
 475                  */
 476                 if (fwd_tag) {
 477                         dest.s_addr = ((struct sockaddr_in *)
 478                                     (fwd_tag + 1))->sin_addr.s_addr;
 479                         m_tag_delete(m, fwd_tag);
 480                         m->m_flags &= ~M_IP_NEXTHOP;
 481                 }
 482                 RTFREE(ro.ro_rt);
 483                 if ((dst = ip_findroute(&ro, dest, m)) == NULL)
 484                         return NULL;    /* icmp unreach already sent */
 485                 ifp = ro.ro_rt->rt_ifp;
 486         }
 487
 488 passout:
 489         /*
 490          * Step 6: send off the packet
 491          */
 492
 493         /*
 494          * Check if route is dampned (when ARP is unable to resolve)
 495          */
 496         if ((ro.ro_rt->rt_flags & RTF_REJECT) &&
 497             (ro.ro_rt->rt_rmx.rmx_expire == 0 ||
 498             time_uptime < ro.ro_rt->rt_rmx.rmx_expire)) {
 499                 icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_HOST, 0, 0);
 500                 goto consumed;
 501         }
 502
 503 #ifndef ALTQ
 504         /*
 505          * Check if there is enough space in the interface queue
 506          */
 507         if ((ifp->if_snd.ifq_len + ip->ip_len / ifp->if_mtu + 1) >=
 508             ifp->if_snd.ifq_maxlen) {
 509                 IPSTAT_INC(ips_odropped);
 510                 /* would send source quench here but that is depreciated */
 511                 goto drop;
 512         }
 513 #endif
 514
 515         /*
 516          * Check if media link state of interface is not down
 517          */
 518         if (ifp->if_link_state == LINK_STATE_DOWN) {
 519                 icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_HOST, 0, 0);
 520                 goto consumed;
 521         }
 522
 523         /*
 524          * Check if packet fits MTU or if hardware will fragment for us
 525          */
 526         if (ro.ro_rt->rt_rmx.rmx_mtu)
 527                 mtu = min(ro.ro_rt->rt_rmx.rmx_mtu, ifp->if_mtu);
 528         else
 529                 mtu = ifp->if_mtu;
 530
 531         if (ip->ip_len <= mtu ||
 532             (ifp->if_hwassist & CSUM_FRAGMENT && (ip->ip_off & IP_DF) == 0)) {
 533                 /*
 534                  * Restore packet header fields to original values
 535                  */
 536                 ip->ip_len = htons(ip->ip_len);
 537                 ip->ip_off = htons(ip->ip_off);
 538                 /*
 539                  * Send off the packet via outgoing interface
 540                  */
 541                 error = (*ifp->if_output)(ifp, m,
 542                                 (struct sockaddr *)dst, &ro);
 543         } else {
 544                 /*
 545                  * Handle EMSGSIZE with icmp reply needfrag for TCP MTU discovery
 546                  */
 547                 if (ip->ip_off & IP_DF) {
 548                         IPSTAT_INC(ips_cantfrag);
 549                         icmp_error(m, ICMP_UNREACH, ICMP_UNREACH_NEEDFRAG,
 550                                 0, mtu);
 551                         goto consumed;
 552                 } else {
 553                         /*
 554                          * We have to fragment the packet
 555                          */
 556                         m->m_pkthdr.csum_flags |= CSUM_IP;
 557                         /*
 558                          * ip_fragment expects ip_len and ip_off in host byte
 559                          * order but returns all packets in network byte order
 560                          */
 561                         if (ip_fragment(ip, &m, mtu, ifp->if_hwassist,
 562                                         (~ifp->if_hwassist & CSUM_DELAY_IP))) {
 563                                 goto drop;
 564                         }
 565                         KASSERT(m != NULL, ("null mbuf and no error"));
 566                         /*
 567                          * Send off the fragments via outgoing interface
 568                          */
 569                         error = 0;
 570                         do {
 571                                 m0 = m->m_nextpkt;
 572                                 m->m_nextpkt = NULL;
 573
 574                                 error = (*ifp->if_output)(ifp, m,
 575                                         (struct sockaddr *)dst, &ro);
 576                                 if (error)
 577                                         break;
 578                         } while ((m = m0) != NULL);
 579                         if (error) {
 580                                 /* Reclaim remaining fragments */
 581                                 for (m = m0; m; m = m0) {
 582                                         m0 = m->m_nextpkt;
 583                                         m_freem(m);
 584                                 }
 585                         } else
 586                                 IPSTAT_INC(ips_fragmented);
 587                 }
 588         }
 589
 590         if (error != 0)
 591                 IPSTAT_INC(ips_odropped);
 592         else {
 593                 ro.ro_rt->rt_rmx.rmx_pksent++;
 594                 IPSTAT_INC(ips_forward);
 595                 IPSTAT_INC(ips_fastforward);
 596         }
 597 consumed:
 598         RTFREE(ro.ro_rt);
 599         return NULL;
 600 drop:
 601         if (m)
 602                 m_freem(m);
 603         if (ro.ro_rt)
 604                 RTFREE(ro.ro_rt);
 605         return NULL;
 606 }