sys/netinet/tcp_syncache.c

   1 /*
   2  * Copyright (c) 2003, 2004 Jeffrey M. Hsu.  All rights reserved.
   3  * Copyright (c) 2003, 2004 The DragonFly Project.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to The DragonFly Project
   6  * by Jeffrey M. Hsu.
   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 DragonFly Project nor the names of its
  17  *    contributors may be used to endorse or promote products derived
  18  *    from this software without specific, prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * All advertising materials mentioning features or use of this software
  36  * must display the following acknowledgement:
  37  *   This product includes software developed by Jeffrey M. Hsu.
  38  *
  39  * Copyright (c) 2001 Networks Associates Technologies, Inc.
  40  * All rights reserved.
  41  *
  42  * This software was developed for the FreeBSD Project by Jonathan Lemon
  43  * and NAI Labs, the Security Research Division of Network Associates, Inc.
  44  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
  45  * DARPA CHATS research program.
  46  *
  47  * Redistribution and use in source and binary forms, with or without
  48  * modification, are permitted provided that the following conditions
  49  * are met:
  50  * 1. Redistributions of source code must retain the above copyright
  51  *    notice, this list of conditions and the following disclaimer.
  52  * 2. Redistributions in binary form must reproduce the above copyright
  53  *    notice, this list of conditions and the following disclaimer in the
  54  *    documentation and/or other materials provided with the distribution.
  55  * 3. The name of the author may not be used to endorse or promote
  56  *    products derived from this software without specific prior written
  57  *    permission.
  58  *
  59  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  69  * SUCH DAMAGE.
  70  *
  71  * $FreeBSD: src/sys/netinet/tcp_syncache.c,v 1.5.2.14 2003/02/24 04:02:27 silby Exp $
  72  * $DragonFly: src/sys/netinet/tcp_syncache.c,v 1.35 2008/11/22 11:03:35 sephe Exp $
  73  */
  74
  75 #include "opt_inet6.h"
  76 #include "opt_ipsec.h"
  77
  78 #include <sys/param.h>
  79 #include <sys/systm.h>
  80 #include <sys/kernel.h>
  81 #include <sys/sysctl.h>
  82 #include <sys/malloc.h>
  83 #include <sys/mbuf.h>
  84 #include <sys/md5.h>
  85 #include <sys/proc.h>           /* for proc0 declaration */
  86 #include <sys/random.h>
  87 #include <sys/socket.h>
  88 #include <sys/socketvar.h>
  89 #include <sys/in_cksum.h>
  90
  91 #include <sys/msgport2.h>
  92 #include <net/netmsg2.h>
  93
  94 #include <net/if.h>
  95 #include <net/route.h>
  96
  97 #include <netinet/in.h>
  98 #include <netinet/in_systm.h>
  99 #include <netinet/ip.h>
 100 #include <netinet/in_var.h>
 101 #include <netinet/in_pcb.h>
 102 #include <netinet/ip_var.h>
 103 #include <netinet/ip6.h>
 104 #ifdef INET6
 105 #include <netinet/icmp6.h>
 106 #include <netinet6/nd6.h>
 107 #endif
 108 #include <netinet6/ip6_var.h>
 109 #include <netinet6/in6_pcb.h>
 110 #include <netinet/tcp.h>
 111 #include <netinet/tcp_fsm.h>
 112 #include <netinet/tcp_seq.h>
 113 #include <netinet/tcp_timer.h>
 114 #include <netinet/tcp_timer2.h>
 115 #include <netinet/tcp_var.h>
 116 #include <netinet6/tcp6_var.h>
 117
 118 #ifdef IPSEC
 119 #include <netinet6/ipsec.h>
 120 #ifdef INET6
 121 #include <netinet6/ipsec6.h>
 122 #endif
 123 #include <netproto/key/key.h>
 124 #endif /*IPSEC*/
 125
 126 #ifdef FAST_IPSEC
 127 #include <netproto/ipsec/ipsec.h>
 128 #ifdef INET6
 129 #include <netproto/ipsec/ipsec6.h>
 130 #endif
 131 #include <netproto/ipsec/key.h>
 132 #define IPSEC
 133 #endif /*FAST_IPSEC*/
 134
 135 static int tcp_syncookies = 1;
 136 SYSCTL_INT(_net_inet_tcp, OID_AUTO, syncookies, CTLFLAG_RW,
 137     &tcp_syncookies, 0,
 138     "Use TCP SYN cookies if the syncache overflows");
 139
 140 static void      syncache_drop(struct syncache *, struct syncache_head *);
 141 static void      syncache_free(struct syncache *);
 142 static void      syncache_insert(struct syncache *, struct syncache_head *);
 143 struct syncache *syncache_lookup(struct in_conninfo *, struct syncache_head **);
 144 static int       syncache_respond(struct syncache *, struct mbuf *);
 145 static struct    socket *syncache_socket(struct syncache *, struct socket *,
 146                     struct mbuf *);
 147 static void      syncache_timer(void *);
 148 static u_int32_t syncookie_generate(struct syncache *);
 149 static struct syncache *syncookie_lookup(struct in_conninfo *,
 150                     struct tcphdr *, struct socket *);
 151
 152 /*
 153  * Transmit the SYN,ACK fewer times than TCP_MAXRXTSHIFT specifies.
 154  * 3 retransmits corresponds to a timeout of (1 + 2 + 4 + 8 == 15) seconds,
 155  * the odds are that the user has given up attempting to connect by then.
 156  */
 157 #define SYNCACHE_MAXREXMTS              3
 158
 159 /* Arbitrary values */
 160 #define TCP_SYNCACHE_HASHSIZE           512
 161 #define TCP_SYNCACHE_BUCKETLIMIT        30
 162
 163 struct netmsg_sc_timer {
 164         struct netmsg nm_netmsg;
 165         struct msgrec *nm_mrec;         /* back pointer to containing msgrec */
 166 };
 167
 168 struct msgrec {
 169         struct netmsg_sc_timer msg;
 170         lwkt_port_t port;               /* constant after init */
 171         int slot;                       /* constant after init */
 172 };
 173
 174 static void syncache_timer_handler(netmsg_t);
 175
 176 struct tcp_syncache {
 177         u_int   hashsize;
 178         u_int   hashmask;
 179         u_int   bucket_limit;
 180         u_int   cache_limit;
 181         u_int   rexmt_limit;
 182         u_int   hash_secret;
 183 };
 184 static struct tcp_syncache tcp_syncache;
 185
 186 struct tcp_syncache_percpu {
 187         struct syncache_head    *hashbase;
 188         u_int                   cache_count;
 189         TAILQ_HEAD(, syncache)  timerq[SYNCACHE_MAXREXMTS + 1];
 190         struct callout          tt_timerq[SYNCACHE_MAXREXMTS + 1];
 191         struct msgrec           mrec[SYNCACHE_MAXREXMTS + 1];
 192 };
 193 static struct tcp_syncache_percpu tcp_syncache_percpu[MAXCPU];
 194
 195 static struct lwkt_port syncache_null_rport;
 196
 197 SYSCTL_NODE(_net_inet_tcp, OID_AUTO, syncache, CTLFLAG_RW, 0, "TCP SYN cache");
 198
 199 SYSCTL_INT(_net_inet_tcp_syncache, OID_AUTO, bucketlimit, CTLFLAG_RD,
 200      &tcp_syncache.bucket_limit, 0, "Per-bucket hash limit for syncache");
 201
 202 SYSCTL_INT(_net_inet_tcp_syncache, OID_AUTO, cachelimit, CTLFLAG_RD,
 203      &tcp_syncache.cache_limit, 0, "Overall entry limit for syncache");
 204
 205 /* XXX JH */
 206 #if 0
 207 SYSCTL_INT(_net_inet_tcp_syncache, OID_AUTO, count, CTLFLAG_RD,
 208      &tcp_syncache.cache_count, 0, "Current number of entries in syncache");
 209 #endif
 210
 211 SYSCTL_INT(_net_inet_tcp_syncache, OID_AUTO, hashsize, CTLFLAG_RD,
 212      &tcp_syncache.hashsize, 0, "Size of TCP syncache hashtable");
 213
 214 SYSCTL_INT(_net_inet_tcp_syncache, OID_AUTO, rexmtlimit, CTLFLAG_RW,
 215      &tcp_syncache.rexmt_limit, 0, "Limit on SYN/ACK retransmissions");
 216
 217 static MALLOC_DEFINE(M_SYNCACHE, "syncache", "TCP syncache");
 218
 219 #define SYNCACHE_HASH(inc, mask)                                        \
 220         ((tcp_syncache.hash_secret ^                                    \
 221           (inc)->inc_faddr.s_addr ^                                     \
 222           ((inc)->inc_faddr.s_addr >> 16) ^                             \
 223           (inc)->inc_fport ^ (inc)->inc_lport) & mask)
 224
 225 #define SYNCACHE_HASH6(inc, mask)                                       \
 226         ((tcp_syncache.hash_secret ^                                    \
 227           (inc)->inc6_faddr.s6_addr32[0] ^                              \
 228           (inc)->inc6_faddr.s6_addr32[3] ^                              \
 229           (inc)->inc_fport ^ (inc)->inc_lport) & mask)
 230
 231 #define ENDPTS_EQ(a, b) (                                               \
 232         (a)->ie_fport == (b)->ie_fport &&                               \
 233         (a)->ie_lport == (b)->ie_lport &&                               \
 234         (a)->ie_faddr.s_addr == (b)->ie_faddr.s_addr &&                 \
 235         (a)->ie_laddr.s_addr == (b)->ie_laddr.s_addr                    \
 236 )
 237
 238 #define ENDPTS6_EQ(a, b) (memcmp(a, b, sizeof(*a)) == 0)
 239
 240 static __inline void
 241 syncache_timeout(struct tcp_syncache_percpu *syncache_percpu,
 242                  struct syncache *sc, int slot)
 243 {
 244         sc->sc_rxtslot = slot;
 245         sc->sc_rxttime = ticks + TCPTV_RTOBASE * tcp_backoff[slot];
 246         TAILQ_INSERT_TAIL(&syncache_percpu->timerq[slot], sc, sc_timerq);
 247         if (!callout_active(&syncache_percpu->tt_timerq[slot])) {
 248                 callout_reset(&syncache_percpu->tt_timerq[slot],
 249                               TCPTV_RTOBASE * tcp_backoff[slot],
 250                               syncache_timer,
 251                               &syncache_percpu->mrec[slot]);
 252         }
 253 }
 254
 255 static void
 256 syncache_free(struct syncache *sc)
 257 {
 258         struct rtentry *rt;
 259 #ifdef INET6
 260         const boolean_t isipv6 = sc->sc_inc.inc_isipv6;
 261 #else
 262         const boolean_t isipv6 = FALSE;
 263 #endif
 264
 265         if (sc->sc_ipopts)
 266                 m_free(sc->sc_ipopts);
 267
 268         rt = isipv6 ? sc->sc_route6.ro_rt : sc->sc_route.ro_rt;
 269         if (rt != NULL) {
 270                 /*
 271                  * If this is the only reference to a protocol-cloned
 272                  * route, remove it immediately.
 273                  */
 274                 if ((rt->rt_flags & RTF_WASCLONED) && rt->rt_refcnt == 1)
 275                         rtrequest(RTM_DELETE, rt_key(rt), rt->rt_gateway,
 276                                   rt_mask(rt), rt->rt_flags, NULL);
 277                 RTFREE(rt);
 278         }
 279         kfree(sc, M_SYNCACHE);
 280 }
 281
 282 void
 283 syncache_init(void)
 284 {
 285         int i, cpu;
 286
 287         tcp_syncache.hashsize = TCP_SYNCACHE_HASHSIZE;
 288         tcp_syncache.bucket_limit = TCP_SYNCACHE_BUCKETLIMIT;
 289         tcp_syncache.cache_limit =
 290             tcp_syncache.hashsize * tcp_syncache.bucket_limit;
 291         tcp_syncache.rexmt_limit = SYNCACHE_MAXREXMTS;
 292         tcp_syncache.hash_secret = karc4random();
 293
 294         TUNABLE_INT_FETCH("net.inet.tcp.syncache.hashsize",
 295             &tcp_syncache.hashsize);
 296         TUNABLE_INT_FETCH("net.inet.tcp.syncache.cachelimit",
 297             &tcp_syncache.cache_limit);
 298         TUNABLE_INT_FETCH("net.inet.tcp.syncache.bucketlimit",
 299             &tcp_syncache.bucket_limit);
 300         if (!powerof2(tcp_syncache.hashsize)) {
 301                 kprintf("WARNING: syncache hash size is not a power of 2.\n");
 302                 tcp_syncache.hashsize = 512;    /* safe default */
 303         }
 304         tcp_syncache.hashmask = tcp_syncache.hashsize - 1;
 305
 306         lwkt_initport_replyonly_null(&syncache_null_rport);
 307
 308         for (cpu = 0; cpu < ncpus2; cpu++) {
 309                 struct tcp_syncache_percpu *syncache_percpu;
 310
 311                 syncache_percpu = &tcp_syncache_percpu[cpu];
 312                 /* Allocate the hash table. */
 313                 MALLOC(syncache_percpu->hashbase, struct syncache_head *,
 314                     tcp_syncache.hashsize * sizeof(struct syncache_head),
 315                     M_SYNCACHE, M_WAITOK);
 316
 317                 /* Initialize the hash buckets. */
 318                 for (i = 0; i < tcp_syncache.hashsize; i++) {
 319                         struct syncache_head *bucket;
 320
 321                         bucket = &syncache_percpu->hashbase[i];
 322                         TAILQ_INIT(&bucket->sch_bucket);
 323                         bucket->sch_length = 0;
 324                 }
 325
 326                 for (i = 0; i <= SYNCACHE_MAXREXMTS; i++) {
 327                         /* Initialize the timer queues. */
 328                         TAILQ_INIT(&syncache_percpu->timerq[i]);
 329                         callout_init(&syncache_percpu->tt_timerq[i]);
 330
 331                         syncache_percpu->mrec[i].slot = i;
 332                         syncache_percpu->mrec[i].port = tcp_cport(cpu);
 333                         syncache_percpu->mrec[i].msg.nm_mrec =
 334                             &syncache_percpu->mrec[i];
 335                         netmsg_init(&syncache_percpu->mrec[i].msg.nm_netmsg,
 336                                     NULL, &syncache_null_rport,
 337                                     0, syncache_timer_handler);
 338                 }
 339         }
 340 }
 341
 342 static void
 343 syncache_insert(struct syncache *sc, struct syncache_head *sch)
 344 {
 345         struct tcp_syncache_percpu *syncache_percpu;
 346         struct syncache *sc2;
 347         int i;
 348
 349         syncache_percpu = &tcp_syncache_percpu[mycpu->gd_cpuid];
 350
 351         /*
 352          * Make sure that we don't overflow the per-bucket
 353          * limit or the total cache size limit.
 354          */
 355         if (sch->sch_length >= tcp_syncache.bucket_limit) {
 356                 /*
 357                  * The bucket is full, toss the oldest element.
 358                  */
 359                 sc2 = TAILQ_FIRST(&sch->sch_bucket);
 360                 sc2->sc_tp->ts_recent = ticks;
 361                 syncache_drop(sc2, sch);
 362                 tcpstat.tcps_sc_bucketoverflow++;
 363         } else if (syncache_percpu->cache_count >= tcp_syncache.cache_limit) {
 364                 /*
 365                  * The cache is full.  Toss the oldest entry in the
 366                  * entire cache.  This is the front entry in the
 367                  * first non-empty timer queue with the largest
 368                  * timeout value.
 369                  */
 370                 for (i = SYNCACHE_MAXREXMTS; i >= 0; i--) {
 371                         sc2 = TAILQ_FIRST(&syncache_percpu->timerq[i]);
 372                         if (sc2 != NULL)
 373                                 break;
 374                 }
 375                 sc2->sc_tp->ts_recent = ticks;
 376                 syncache_drop(sc2, NULL);
 377                 tcpstat.tcps_sc_cacheoverflow++;
 378         }
 379
 380         /* Initialize the entry's timer. */
 381         syncache_timeout(syncache_percpu, sc, 0);
 382
 383         /* Put it into the bucket. */
 384         TAILQ_INSERT_TAIL(&sch->sch_bucket, sc, sc_hash);
 385         sch->sch_length++;
 386         syncache_percpu->cache_count++;
 387         tcpstat.tcps_sc_added++;
 388 }
 389
 390 static void
 391 syncache_drop(struct syncache *sc, struct syncache_head *sch)
 392 {
 393         struct tcp_syncache_percpu *syncache_percpu;
 394 #ifdef INET6
 395         const boolean_t isipv6 = sc->sc_inc.inc_isipv6;
 396 #else
 397         const boolean_t isipv6 = FALSE;
 398 #endif
 399
 400         syncache_percpu = &tcp_syncache_percpu[mycpu->gd_cpuid];
 401
 402         if (sch == NULL) {
 403                 if (isipv6) {
 404                         sch = &syncache_percpu->hashbase[
 405                             SYNCACHE_HASH6(&sc->sc_inc, tcp_syncache.hashmask)];
 406                 } else {
 407                         sch = &syncache_percpu->hashbase[
 408                             SYNCACHE_HASH(&sc->sc_inc, tcp_syncache.hashmask)];
 409                 }
 410         }
 411
 412         TAILQ_REMOVE(&sch->sch_bucket, sc, sc_hash);
 413         sch->sch_length--;
 414         syncache_percpu->cache_count--;
 415
 416         /*
 417          * Remove the entry from the syncache timer/timeout queue.  Note
 418          * that we do not try to stop any running timer since we do not know
 419          * whether the timer's message is in-transit or not.  Since timeouts
 420          * are fairly long, taking an unneeded callout does not detrimentally
 421          * effect performance.
 422          */
 423         TAILQ_REMOVE(&syncache_percpu->timerq[sc->sc_rxtslot], sc, sc_timerq);
 424
 425         syncache_free(sc);
 426 }
 427
 428 /*
 429  * Place a timeout message on the TCP thread's message queue.
 430  * This routine runs in soft interrupt context.
 431  *
 432  * An invariant is for this routine to be called, the callout must
 433  * have been active.  Note that the callout is not deactivated until
 434  * after the message has been processed in syncache_timer_handler() below.
 435  */
 436 static void
 437 syncache_timer(void *p)
 438 {
 439         struct netmsg_sc_timer *msg = p;
 440
 441         lwkt_sendmsg(msg->nm_mrec->port, &msg->nm_netmsg.nm_lmsg);
 442 }
 443
 444 /*
 445  * Service a timer message queued by timer expiration.
 446  * This routine runs in the TCP protocol thread.
 447  *
 448  * Walk the timer queues, looking for SYN,ACKs that need to be retransmitted.
 449  * If we have retransmitted an entry the maximum number of times, expire it.
 450  *
 451  * When we finish processing timed-out entries, we restart the timer if there
 452  * are any entries still on the queue and deactivate it otherwise.  Only after
 453  * a timer has been deactivated here can it be restarted by syncache_timeout().
 454  */
 455 static void
 456 syncache_timer_handler(netmsg_t netmsg)
 457 {
 458         struct tcp_syncache_percpu *syncache_percpu;
 459         struct syncache *sc, *nsc;
 460         struct inpcb *inp;
 461         int slot;
 462
 463         slot = ((struct netmsg_sc_timer *)netmsg)->nm_mrec->slot;
 464         syncache_percpu = &tcp_syncache_percpu[mycpu->gd_cpuid];
 465
 466         nsc = TAILQ_FIRST(&syncache_percpu->timerq[slot]);
 467         while (nsc != NULL) {
 468                 if (ticks < nsc->sc_rxttime)
 469                         break;  /* finished because timerq sorted by time */
 470                 sc = nsc;
 471                 inp = sc->sc_tp->t_inpcb;
 472                 if (slot == SYNCACHE_MAXREXMTS ||
 473                     slot >= tcp_syncache.rexmt_limit ||
 474                     inp->inp_gencnt != sc->sc_inp_gencnt) {
 475                         nsc = TAILQ_NEXT(sc, sc_timerq);
 476                         syncache_drop(sc, NULL);
 477                         tcpstat.tcps_sc_stale++;
 478                         continue;
 479                 }
 480                 /*
 481                  * syncache_respond() may call back into the syncache to
 482                  * to modify another entry, so do not obtain the next
 483                  * entry on the timer chain until it has completed.
 484                  */
 485                 syncache_respond(sc, NULL);
 486                 nsc = TAILQ_NEXT(sc, sc_timerq);
 487                 tcpstat.tcps_sc_retransmitted++;
 488                 TAILQ_REMOVE(&syncache_percpu->timerq[slot], sc, sc_timerq);
 489                 syncache_timeout(syncache_percpu, sc, slot + 1);
 490         }
 491         if (nsc != NULL)
 492                 callout_reset(&syncache_percpu->tt_timerq[slot],
 493                     nsc->sc_rxttime - ticks, syncache_timer,
 494                     &syncache_percpu->mrec[slot]);
 495         else
 496                 callout_deactivate(&syncache_percpu->tt_timerq[slot]);
 497
 498         lwkt_replymsg(&netmsg->nm_lmsg, 0);
 499 }
 500
 501 /*
 502  * Find an entry in the syncache.
 503  */
 504 struct syncache *
 505 syncache_lookup(struct in_conninfo *inc, struct syncache_head **schp)
 506 {
 507         struct tcp_syncache_percpu *syncache_percpu;
 508         struct syncache *sc;
 509         struct syncache_head *sch;
 510
 511         syncache_percpu = &tcp_syncache_percpu[mycpu->gd_cpuid];
 512 #ifdef INET6
 513         if (inc->inc_isipv6) {
 514                 sch = &syncache_percpu->hashbase[
 515                     SYNCACHE_HASH6(inc, tcp_syncache.hashmask)];
 516                 *schp = sch;
 517                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash)
 518                         if (ENDPTS6_EQ(&inc->inc_ie, &sc->sc_inc.inc_ie))
 519                                 return (sc);
 520         } else
 521 #endif
 522         {
 523                 sch = &syncache_percpu->hashbase[
 524                     SYNCACHE_HASH(inc, tcp_syncache.hashmask)];
 525                 *schp = sch;
 526                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash) {
 527 #ifdef INET6
 528                         if (sc->sc_inc.inc_isipv6)
 529                                 continue;
 530 #endif
 531                         if (ENDPTS_EQ(&inc->inc_ie, &sc->sc_inc.inc_ie))
 532                                 return (sc);
 533                 }
 534         }
 535         return (NULL);
 536 }
 537
 538 /*
 539  * This function is called when we get a RST for a
 540  * non-existent connection, so that we can see if the
 541  * connection is in the syn cache.  If it is, zap it.
 542  */
 543 void
 544 syncache_chkrst(struct in_conninfo *inc, struct tcphdr *th)
 545 {
 546         struct syncache *sc;
 547         struct syncache_head *sch;
 548
 549         sc = syncache_lookup(inc, &sch);
 550         if (sc == NULL)
 551                 return;
 552         /*
 553          * If the RST bit is set, check the sequence number to see
 554          * if this is a valid reset segment.
 555          * RFC 793 page 37:
 556          *   In all states except SYN-SENT, all reset (RST) segments
 557          *   are validated by checking their SEQ-fields.  A reset is
 558          *   valid if its sequence number is in the window.
 559          *
 560          *   The sequence number in the reset segment is normally an
 561          *   echo of our outgoing acknowlegement numbers, but some hosts
 562          *   send a reset with the sequence number at the rightmost edge
 563          *   of our receive window, and we have to handle this case.
 564          */
 565         if (SEQ_GEQ(th->th_seq, sc->sc_irs) &&
 566             SEQ_LEQ(th->th_seq, sc->sc_irs + sc->sc_wnd)) {
 567                 syncache_drop(sc, sch);
 568                 tcpstat.tcps_sc_reset++;
 569         }
 570 }
 571
 572 void
 573 syncache_badack(struct in_conninfo *inc)
 574 {
 575         struct syncache *sc;
 576         struct syncache_head *sch;
 577
 578         sc = syncache_lookup(inc, &sch);
 579         if (sc != NULL) {
 580                 syncache_drop(sc, sch);
 581                 tcpstat.tcps_sc_badack++;
 582         }
 583 }
 584
 585 void
 586 syncache_unreach(struct in_conninfo *inc, struct tcphdr *th)
 587 {
 588         struct syncache *sc;
 589         struct syncache_head *sch;
 590
 591         /* we are called at splnet() here */
 592         sc = syncache_lookup(inc, &sch);
 593         if (sc == NULL)
 594                 return;
 595
 596         /* If the sequence number != sc_iss, then it's a bogus ICMP msg */
 597         if (ntohl(th->th_seq) != sc->sc_iss)
 598                 return;
 599
 600         /*
 601          * If we've rertransmitted 3 times and this is our second error,
 602          * we remove the entry.  Otherwise, we allow it to continue on.
 603          * This prevents us from incorrectly nuking an entry during a
 604          * spurious network outage.
 605          *
 606          * See tcp_notify().
 607          */
 608         if ((sc->sc_flags & SCF_UNREACH) == 0 || sc->sc_rxtslot < 3) {
 609                 sc->sc_flags |= SCF_UNREACH;
 610                 return;
 611         }
 612         syncache_drop(sc, sch);
 613         tcpstat.tcps_sc_unreach++;
 614 }
 615
 616 /*
 617  * Build a new TCP socket structure from a syncache entry.
 618  *
 619  * This is called from the context of the SYN+ACK
 620  */
 621 static struct socket *
 622 syncache_socket(struct syncache *sc, struct socket *lso, struct mbuf *m)
 623 {
 624         struct inpcb *inp = NULL, *linp;
 625         struct socket *so;
 626         struct tcpcb *tp;
 627         lwkt_port_t port;
 628 #ifdef INET6
 629         const boolean_t isipv6 = sc->sc_inc.inc_isipv6;
 630 #else
 631         const boolean_t isipv6 = FALSE;
 632 #endif
 633
 634         /*
 635          * Ok, create the full blown connection, and set things up
 636          * as they would have been set up if we had created the
 637          * connection when the SYN arrived.  If we can't create
 638          * the connection, abort it.
 639          */
 640         so = sonewconn(lso, SS_ISCONNECTED);
 641         if (so == NULL) {
 642                 /*
 643                  * Drop the connection; we will send a RST if the peer
 644                  * retransmits the ACK,
 645                  */
 646                 tcpstat.tcps_listendrop++;
 647                 goto abort;
 648         }
 649
 650         /*
 651          * Set the protocol processing port for the socket to the current
 652          * port (that the connection came in on).
 653          */
 654         sosetport(so, &curthread->td_msgport);
 655
 656         /*
 657          * Insert new socket into hash list.
 658          */
 659         inp = so->so_pcb;
 660         inp->inp_inc.inc_isipv6 = sc->sc_inc.inc_isipv6;
 661         if (isipv6) {
 662                 inp->in6p_laddr = sc->sc_inc.inc6_laddr;
 663         } else {
 664 #ifdef INET6
 665                 inp->inp_vflag &= ~INP_IPV6;
 666                 inp->inp_vflag |= INP_IPV4;
 667                 inp->inp_flags &= ~IN6P_IPV6_V6ONLY;
 668 #endif
 669                 inp->inp_laddr = sc->sc_inc.inc_laddr;
 670         }
 671         inp->inp_lport = sc->sc_inc.inc_lport;
 672         if (in_pcbinsporthash(inp) != 0) {
 673                 /*
 674                  * Undo the assignments above if we failed to
 675                  * put the PCB on the hash lists.
 676                  */
 677                 if (isipv6)
 678                         inp->in6p_laddr = kin6addr_any;
 679                 else
 680                         inp->inp_laddr.s_addr = INADDR_ANY;
 681                 inp->inp_lport = 0;
 682                 goto abort;
 683         }
 684         linp = so->so_pcb;
 685 #ifdef IPSEC
 686         /* copy old policy into new socket's */
 687         if (ipsec_copy_policy(linp->inp_sp, inp->inp_sp))
 688                 kprintf("syncache_expand: could not copy policy\n");
 689 #endif
 690         if (isipv6) {
 691                 struct in6_addr laddr6;
 692                 struct sockaddr_in6 sin6;
 693                 /*
 694                  * Inherit socket options from the listening socket.
 695                  * Note that in6p_inputopts are not (and should not be)
 696                  * copied, since it stores previously received options and is
 697                  * used to detect if each new option is different than the
 698                  * previous one and hence should be passed to a user.
 699                  * If we copied in6p_inputopts, a user would not be able to
 700                  * receive options just after calling the accept system call.
 701                  */
 702                 inp->inp_flags |= linp->inp_flags & INP_CONTROLOPTS;
 703                 if (linp->in6p_outputopts)
 704                         inp->in6p_outputopts =
 705                             ip6_copypktopts(linp->in6p_outputopts, M_INTWAIT);
 706                 inp->in6p_route = sc->sc_route6;
 707                 sc->sc_route6.ro_rt = NULL;
 708
 709                 sin6.sin6_family = AF_INET6;
 710                 sin6.sin6_len = sizeof sin6;
 711                 sin6.sin6_addr = sc->sc_inc.inc6_faddr;
 712                 sin6.sin6_port = sc->sc_inc.inc_fport;
 713                 sin6.sin6_flowinfo = sin6.sin6_scope_id = 0;
 714                 laddr6 = inp->in6p_laddr;
 715                 if (IN6_IS_ADDR_UNSPECIFIED(&inp->in6p_laddr))
 716                         inp->in6p_laddr = sc->sc_inc.inc6_laddr;
 717                 if (in6_pcbconnect(inp, (struct sockaddr *)&sin6, &thread0)) {
 718                         inp->in6p_laddr = laddr6;
 719                         goto abort;
 720                 }
 721         } else {
 722                 struct in_addr laddr;
 723                 struct sockaddr_in sin;
 724
 725                 inp->inp_options = ip_srcroute(m);
 726                 if (inp->inp_options == NULL) {
 727                         inp->inp_options = sc->sc_ipopts;
 728                         sc->sc_ipopts = NULL;
 729                 }
 730                 inp->inp_route = sc->sc_route;
 731                 sc->sc_route.ro_rt = NULL;
 732
 733                 sin.sin_family = AF_INET;
 734                 sin.sin_len = sizeof sin;
 735                 sin.sin_addr = sc->sc_inc.inc_faddr;
 736                 sin.sin_port = sc->sc_inc.inc_fport;
 737                 bzero(sin.sin_zero, sizeof sin.sin_zero);
 738                 laddr = inp->inp_laddr;
 739                 if (inp->inp_laddr.s_addr == INADDR_ANY)
 740                         inp->inp_laddr = sc->sc_inc.inc_laddr;
 741                 if (in_pcbconnect(inp, (struct sockaddr *)&sin, &thread0)) {
 742                         inp->inp_laddr = laddr;
 743                         goto abort;
 744                 }
 745         }
 746
 747         /*
 748          * The current port should be in the context of the SYN+ACK and
 749          * so should match the tcp address port.
 750          *
 751          * XXX we may be running on the netisr thread instead of a tcp
 752          *     thread, in which case port will not match
 753          *     curthread->td_msgport.
 754          */
 755         if (isipv6) {
 756                 port = tcp6_addrport();
 757         } else {
 758                 port = tcp_addrport(inp->inp_faddr.s_addr, inp->inp_fport,
 759                                     inp->inp_laddr.s_addr, inp->inp_lport);
 760         }
 761         /*KKASSERT(port == &curthread->td_msgport);*/
 762
 763         tp = intotcpcb(inp);
 764         tp->t_state = TCPS_SYN_RECEIVED;
 765         tp->iss = sc->sc_iss;
 766         tp->irs = sc->sc_irs;
 767         tcp_rcvseqinit(tp);
 768         tcp_sendseqinit(tp);
 769         tp->snd_wl1 = sc->sc_irs;
 770         tp->rcv_up = sc->sc_irs + 1;
 771         tp->rcv_wnd = sc->sc_wnd;
 772         tp->rcv_adv += tp->rcv_wnd;
 773
 774         tp->t_flags = sototcpcb(lso)->t_flags & (TF_NOPUSH | TF_NODELAY);
 775         if (sc->sc_flags & SCF_NOOPT)
 776                 tp->t_flags |= TF_NOOPT;
 777         if (sc->sc_flags & SCF_WINSCALE) {
 778                 tp->t_flags |= TF_REQ_SCALE | TF_RCVD_SCALE;
 779                 tp->requested_s_scale = sc->sc_requested_s_scale;
 780                 tp->request_r_scale = sc->sc_request_r_scale;
 781         }
 782         if (sc->sc_flags & SCF_TIMESTAMP) {
 783                 tp->t_flags |= TF_REQ_TSTMP | TF_RCVD_TSTMP;
 784                 tp->ts_recent = sc->sc_tsrecent;
 785                 tp->ts_recent_age = ticks;
 786         }
 787         if (sc->sc_flags & SCF_SACK_PERMITTED)
 788                 tp->t_flags |= TF_SACK_PERMITTED;
 789
 790         tcp_mss(tp, sc->sc_peer_mss);
 791
 792         /*
 793          * If the SYN,ACK was retransmitted, reset cwnd to 1 segment.
 794          */
 795         if (sc->sc_rxtslot != 0)
 796                 tp->snd_cwnd = tp->t_maxseg;
 797         tcp_create_timermsg(tp, port);
 798         tcp_callout_reset(tp, tp->tt_keep, tcp_keepinit, tcp_timer_keep);
 799
 800         tcpstat.tcps_accepts++;
 801         return (so);
 802
 803 abort:
 804         if (so != NULL)
 805                 soabort_oncpu(so);
 806         return (NULL);
 807 }
 808
 809 /*
 810  * This function gets called when we receive an ACK for a
 811  * socket in the LISTEN state.  We look up the connection
 812  * in the syncache, and if its there, we pull it out of
 813  * the cache and turn it into a full-blown connection in
 814  * the SYN-RECEIVED state.
 815  */
 816 int
 817 syncache_expand(struct in_conninfo *inc, struct tcphdr *th, struct socket **sop,
 818                 struct mbuf *m)
 819 {
 820         struct syncache *sc;
 821         struct syncache_head *sch;
 822         struct socket *so;
 823
 824         sc = syncache_lookup(inc, &sch);
 825         if (sc == NULL) {
 826                 /*
 827                  * There is no syncache entry, so see if this ACK is
 828                  * a returning syncookie.  To do this, first:
 829                  *  A. See if this socket has had a syncache entry dropped in
 830                  *     the past.  We don't want to accept a bogus syncookie
 831                  *     if we've never received a SYN.
 832                  *  B. check that the syncookie is valid.  If it is, then
 833                  *     cobble up a fake syncache entry, and return.
 834                  */
 835                 if (!tcp_syncookies)
 836                         return (0);
 837                 sc = syncookie_lookup(inc, th, *sop);
 838                 if (sc == NULL)
 839                         return (0);
 840                 sch = NULL;
 841                 tcpstat.tcps_sc_recvcookie++;
 842         }
 843
 844         /*
 845          * If seg contains an ACK, but not for our SYN/ACK, send a RST.
 846          */
 847         if (th->th_ack != sc->sc_iss + 1)
 848                 return (0);
 849
 850         so = syncache_socket(sc, *sop, m);
 851         if (so == NULL) {
 852 #if 0
 853 resetandabort:
 854                 /* XXXjlemon check this - is this correct? */
 855                 tcp_respond(NULL, m, m, th,
 856                     th->th_seq + tlen, (tcp_seq)0, TH_RST | TH_ACK);
 857 #endif
 858                 m_freem(m);                     /* XXX only needed for above */
 859                 tcpstat.tcps_sc_aborted++;
 860         } else {
 861                 tcpstat.tcps_sc_completed++;
 862         }
 863         if (sch == NULL)
 864                 syncache_free(sc);
 865         else
 866                 syncache_drop(sc, sch);
 867         *sop = so;
 868         return (1);
 869 }
 870
 871 /*
 872  * Given a LISTEN socket and an inbound SYN request, add
 873  * this to the syn cache, and send back a segment:
 874  *      <SEQ=ISS><ACK=RCV_NXT><CTL=SYN,ACK>
 875  * to the source.
 876  *
 877  * IMPORTANT NOTE: We do _NOT_ ACK data that might accompany the SYN.
 878  * Doing so would require that we hold onto the data and deliver it
 879  * to the application.  However, if we are the target of a SYN-flood
 880  * DoS attack, an attacker could send data which would eventually
 881  * consume all available buffer space if it were ACKed.  By not ACKing
 882  * the data, we avoid this DoS scenario.
 883  */
 884 int
 885 syncache_add(struct in_conninfo *inc, struct tcpopt *to, struct tcphdr *th,
 886              struct socket **sop, struct mbuf *m)
 887 {
 888         struct tcp_syncache_percpu *syncache_percpu;
 889         struct tcpcb *tp;
 890         struct socket *so;
 891         struct syncache *sc = NULL;
 892         struct syncache_head *sch;
 893         struct mbuf *ipopts = NULL;
 894         int win;
 895
 896         syncache_percpu = &tcp_syncache_percpu[mycpu->gd_cpuid];
 897         so = *sop;
 898         tp = sototcpcb(so);
 899
 900         /*
 901          * Remember the IP options, if any.
 902          */
 903 #ifdef INET6
 904         if (!inc->inc_isipv6)
 905 #endif
 906                 ipopts = ip_srcroute(m);
 907
 908         /*
 909          * See if we already have an entry for this connection.
 910          * If we do, resend the SYN,ACK, and reset the retransmit timer.
 911          *
 912          * XXX
 913          * The syncache should be re-initialized with the contents
 914          * of the new SYN which may have different options.
 915          */
 916         sc = syncache_lookup(inc, &sch);
 917         if (sc != NULL) {
 918                 tcpstat.tcps_sc_dupsyn++;
 919                 if (ipopts) {
 920                         /*
 921                          * If we were remembering a previous source route,
 922                          * forget it and use the new one we've been given.
 923                          */
 924                         if (sc->sc_ipopts)
 925                                 m_free(sc->sc_ipopts);
 926                         sc->sc_ipopts = ipopts;
 927                 }
 928                 /*
 929                  * Update timestamp if present.
 930                  */
 931                 if (sc->sc_flags & SCF_TIMESTAMP)
 932                         sc->sc_tsrecent = to->to_tsval;
 933
 934                 /* Just update the TOF_SACK_PERMITTED for now. */
 935                 if (tcp_do_sack && (to->to_flags & TOF_SACK_PERMITTED))
 936                         sc->sc_flags |= SCF_SACK_PERMITTED;
 937                 else
 938                         sc->sc_flags &= ~SCF_SACK_PERMITTED;
 939
 940                 /*
 941                  * PCB may have changed, pick up new values.
 942                  */
 943                 sc->sc_tp = tp;
 944                 sc->sc_inp_gencnt = tp->t_inpcb->inp_gencnt;
 945                 if (syncache_respond(sc, m) == 0) {
 946                         TAILQ_REMOVE(&syncache_percpu->timerq[sc->sc_rxtslot],
 947                             sc, sc_timerq);
 948                         syncache_timeout(syncache_percpu, sc, sc->sc_rxtslot);
 949                         tcpstat.tcps_sndacks++;
 950                         tcpstat.tcps_sndtotal++;
 951                 }
 952                 *sop = NULL;
 953                 return (1);
 954         }
 955
 956         /*
 957          * Fill in the syncache values.
 958          */
 959         sc = kmalloc(sizeof(struct syncache), M_SYNCACHE, M_WAITOK|M_ZERO);
 960         sc->sc_tp = tp;
 961         sc->sc_inp_gencnt = tp->t_inpcb->inp_gencnt;
 962         sc->sc_ipopts = ipopts;
 963         sc->sc_inc.inc_fport = inc->inc_fport;
 964         sc->sc_inc.inc_lport = inc->inc_lport;
 965 #ifdef INET6
 966         sc->sc_inc.inc_isipv6 = inc->inc_isipv6;
 967         if (inc->inc_isipv6) {
 968                 sc->sc_inc.inc6_faddr = inc->inc6_faddr;
 969                 sc->sc_inc.inc6_laddr = inc->inc6_laddr;
 970                 sc->sc_route6.ro_rt = NULL;
 971         } else
 972 #endif
 973         {
 974                 sc->sc_inc.inc_faddr = inc->inc_faddr;
 975                 sc->sc_inc.inc_laddr = inc->inc_laddr;
 976                 sc->sc_route.ro_rt = NULL;
 977         }
 978         sc->sc_irs = th->th_seq;
 979         sc->sc_flags = 0;
 980         sc->sc_peer_mss = to->to_flags & TOF_MSS ? to->to_mss : 0;
 981         if (tcp_syncookies)
 982                 sc->sc_iss = syncookie_generate(sc);
 983         else
 984                 sc->sc_iss = karc4random();
 985
 986         /* Initial receive window: clip ssb_space to [0 .. TCP_MAXWIN] */
 987         win = ssb_space(&so->so_rcv);
 988         win = imax(win, 0);
 989         win = imin(win, TCP_MAXWIN);
 990         sc->sc_wnd = win;
 991
 992         if (tcp_do_rfc1323) {
 993                 /*
 994                  * A timestamp received in a SYN makes
 995                  * it ok to send timestamp requests and replies.
 996                  */
 997                 if (to->to_flags & TOF_TS) {
 998                         sc->sc_tsrecent = to->to_tsval;
 999                         sc->sc_flags |= SCF_TIMESTAMP;
1000                 }
1001                 if (to->to_flags & TOF_SCALE) {
1002                         int wscale = TCP_MIN_WINSHIFT;
1003
1004                         /* Compute proper scaling value from buffer space */
1005                         while (wscale < TCP_MAX_WINSHIFT &&
1006                             (TCP_MAXWIN << wscale) < so->so_rcv.ssb_hiwat) {
1007                                 wscale++;
1008                         }
1009                         sc->sc_request_r_scale = wscale;
1010                         sc->sc_requested_s_scale = to->to_requested_s_scale;
1011                         sc->sc_flags |= SCF_WINSCALE;
1012                 }
1013         }
1014         if (tcp_do_sack && (to->to_flags & TOF_SACK_PERMITTED))
1015                 sc->sc_flags |= SCF_SACK_PERMITTED;
1016         if (tp->t_flags & TF_NOOPT)
1017                 sc->sc_flags = SCF_NOOPT;
1018
1019         if (syncache_respond(sc, m) == 0) {
1020                 syncache_insert(sc, sch);
1021                 tcpstat.tcps_sndacks++;
1022                 tcpstat.tcps_sndtotal++;
1023         } else {
1024                 syncache_free(sc);
1025                 tcpstat.tcps_sc_dropped++;
1026         }
1027         *sop = NULL;
1028         return (1);
1029 }
1030
1031 static int
1032 syncache_respond(struct syncache *sc, struct mbuf *m)
1033 {
1034         u_int8_t *optp;
1035         int optlen, error;
1036         u_int16_t tlen, hlen, mssopt;
1037         struct ip *ip = NULL;
1038         struct rtentry *rt;
1039         struct tcphdr *th;
1040         struct ip6_hdr *ip6 = NULL;
1041 #ifdef INET6
1042         const boolean_t isipv6 = sc->sc_inc.inc_isipv6;
1043 #else
1044         const boolean_t isipv6 = FALSE;
1045 #endif
1046
1047         if (isipv6) {
1048                 rt = tcp_rtlookup6(&sc->sc_inc);
1049                 if (rt != NULL)
1050                         mssopt = rt->rt_ifp->if_mtu -
1051                              (sizeof(struct ip6_hdr) + sizeof(struct tcphdr));
1052                 else
1053                         mssopt = tcp_v6mssdflt;
1054                 hlen = sizeof(struct ip6_hdr);
1055         } else {
1056                 rt = tcp_rtlookup(&sc->sc_inc);
1057                 if (rt != NULL)
1058                         mssopt = rt->rt_ifp->if_mtu -
1059                              (sizeof(struct ip) + sizeof(struct tcphdr));
1060                 else
1061                         mssopt = tcp_mssdflt;
1062                 hlen = sizeof(struct ip);
1063         }
1064
1065         /* Compute the size of the TCP options. */
1066         if (sc->sc_flags & SCF_NOOPT) {
1067                 optlen = 0;
1068         } else {
1069                 optlen = TCPOLEN_MAXSEG +
1070                     ((sc->sc_flags & SCF_WINSCALE) ? 4 : 0) +
1071                     ((sc->sc_flags & SCF_TIMESTAMP) ? TCPOLEN_TSTAMP_APPA : 0) +
1072                     ((sc->sc_flags & SCF_SACK_PERMITTED) ?
1073                         TCPOLEN_SACK_PERMITTED_ALIGNED : 0);
1074         }
1075         tlen = hlen + sizeof(struct tcphdr) + optlen;
1076
1077         /*
1078          * XXX
1079          * assume that the entire packet will fit in a header mbuf
1080          */
1081         KASSERT(max_linkhdr + tlen <= MHLEN, ("syncache: mbuf too small"));
1082
1083         /*
1084          * XXX shouldn't this reuse the mbuf if possible ?
1085          * Create the IP+TCP header from scratch.
1086          */
1087         if (m)
1088                 m_freem(m);
1089
1090         m = m_gethdr(MB_DONTWAIT, MT_HEADER);
1091         if (m == NULL)
1092                 return (ENOBUFS);
1093         m->m_data += max_linkhdr;
1094         m->m_len = tlen;
1095         m->m_pkthdr.len = tlen;
1096         m->m_pkthdr.rcvif = NULL;
1097
1098         if (isipv6) {
1099                 ip6 = mtod(m, struct ip6_hdr *);
1100                 ip6->ip6_vfc = IPV6_VERSION;
1101                 ip6->ip6_nxt = IPPROTO_TCP;
1102                 ip6->ip6_src = sc->sc_inc.inc6_laddr;
1103                 ip6->ip6_dst = sc->sc_inc.inc6_faddr;
1104                 ip6->ip6_plen = htons(tlen - hlen);
1105                 /* ip6_hlim is set after checksum */
1106                 /* ip6_flow = ??? */
1107
1108                 th = (struct tcphdr *)(ip6 + 1);
1109         } else {
1110                 ip = mtod(m, struct ip *);
1111                 ip->ip_v = IPVERSION;
1112                 ip->ip_hl = sizeof(struct ip) >> 2;
1113                 ip->ip_len = tlen;
1114                 ip->ip_id = 0;
1115                 ip->ip_off = 0;
1116                 ip->ip_sum = 0;
1117                 ip->ip_p = IPPROTO_TCP;
1118                 ip->ip_src = sc->sc_inc.inc_laddr;
1119                 ip->ip_dst = sc->sc_inc.inc_faddr;
1120                 ip->ip_ttl = sc->sc_tp->t_inpcb->inp_ip_ttl;   /* XXX */
1121                 ip->ip_tos = sc->sc_tp->t_inpcb->inp_ip_tos;   /* XXX */
1122
1123                 /*
1124                  * See if we should do MTU discovery.  Route lookups are
1125                  * expensive, so we will only unset the DF bit if:
1126                  *
1127                  *      1) path_mtu_discovery is disabled
1128                  *      2) the SCF_UNREACH flag has been set
1129                  */
1130                 if (path_mtu_discovery
1131                     && ((sc->sc_flags & SCF_UNREACH) == 0)) {
1132                        ip->ip_off |= IP_DF;
1133                 }
1134
1135                 th = (struct tcphdr *)(ip + 1);
1136         }
1137         th->th_sport = sc->sc_inc.inc_lport;
1138         th->th_dport = sc->sc_inc.inc_fport;
1139
1140         th->th_seq = htonl(sc->sc_iss);
1141         th->th_ack = htonl(sc->sc_irs + 1);
1142         th->th_off = (sizeof(struct tcphdr) + optlen) >> 2;
1143         th->th_x2 = 0;
1144         th->th_flags = TH_SYN | TH_ACK;
1145         th->th_win = htons(sc->sc_wnd);
1146         th->th_urp = 0;
1147
1148         /* Tack on the TCP options. */
1149         if (optlen == 0)
1150                 goto no_options;
1151         optp = (u_int8_t *)(th + 1);
1152         *optp++ = TCPOPT_MAXSEG;
1153         *optp++ = TCPOLEN_MAXSEG;
1154         *optp++ = (mssopt >> 8) & 0xff;
1155         *optp++ = mssopt & 0xff;
1156
1157         if (sc->sc_flags & SCF_WINSCALE) {
1158                 *((u_int32_t *)optp) = htonl(TCPOPT_NOP << 24 |
1159                     TCPOPT_WINDOW << 16 | TCPOLEN_WINDOW << 8 |
1160                     sc->sc_request_r_scale);
1161                 optp += 4;
1162         }
1163
1164         if (sc->sc_flags & SCF_TIMESTAMP) {
1165                 u_int32_t *lp = (u_int32_t *)(optp);
1166
1167                 /* Form timestamp option as shown in appendix A of RFC 1323. */
1168                 *lp++ = htonl(TCPOPT_TSTAMP_HDR);
1169                 *lp++ = htonl(ticks);
1170                 *lp   = htonl(sc->sc_tsrecent);
1171                 optp += TCPOLEN_TSTAMP_APPA;
1172         }
1173
1174         if (sc->sc_flags & SCF_SACK_PERMITTED) {
1175                 *((u_int32_t *)optp) = htonl(TCPOPT_SACK_PERMITTED_ALIGNED);
1176                 optp += TCPOLEN_SACK_PERMITTED_ALIGNED;
1177         }
1178
1179 no_options:
1180         if (isipv6) {
1181                 struct route_in6 *ro6 = &sc->sc_route6;
1182
1183                 th->th_sum = 0;
1184                 th->th_sum = in6_cksum(m, IPPROTO_TCP, hlen, tlen - hlen);
1185                 ip6->ip6_hlim = in6_selecthlim(NULL,
1186                     ro6->ro_rt ? ro6->ro_rt->rt_ifp : NULL);
1187                 error = ip6_output(m, NULL, ro6, 0, NULL, NULL,
1188                                 sc->sc_tp->t_inpcb);
1189         } else {
1190                 th->th_sum = in_pseudo(ip->ip_src.s_addr, ip->ip_dst.s_addr,
1191                                        htons(tlen - hlen + IPPROTO_TCP));
1192                 m->m_pkthdr.csum_flags = CSUM_TCP;
1193                 m->m_pkthdr.csum_data = offsetof(struct tcphdr, th_sum);
1194                 error = ip_output(m, sc->sc_ipopts, &sc->sc_route,
1195                                   IP_DEBUGROUTE, NULL, sc->sc_tp->t_inpcb);
1196         }
1197         return (error);
1198 }
1199
1200 /*
1201  * cookie layers:
1202  *
1203  *      |. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .|
1204  *      | peer iss                                                      |
1205  *      | MD5(laddr,faddr,secret,lport,fport)             |. . . . . . .|
1206  *      |                     0                       |(A)|             |
1207  * (A): peer mss index
1208  */
1209
1210 /*
1211  * The values below are chosen to minimize the size of the tcp_secret
1212  * table, as well as providing roughly a 16 second lifetime for the cookie.
1213  */
1214
1215 #define SYNCOOKIE_WNDBITS       5       /* exposed bits for window indexing */
1216 #define SYNCOOKIE_TIMESHIFT     1       /* scale ticks to window time units */
1217
1218 #define SYNCOOKIE_WNDMASK       ((1 << SYNCOOKIE_WNDBITS) - 1)
1219 #define SYNCOOKIE_NSECRETS      (1 << SYNCOOKIE_WNDBITS)
1220 #define SYNCOOKIE_TIMEOUT \
1221     (hz * (1 << SYNCOOKIE_WNDBITS) / (1 << SYNCOOKIE_TIMESHIFT))
1222 #define SYNCOOKIE_DATAMASK      ((3 << SYNCOOKIE_WNDBITS) | SYNCOOKIE_WNDMASK)
1223
1224 static struct {
1225         u_int32_t       ts_secbits[4];
1226         u_int           ts_expire;
1227 } tcp_secret[SYNCOOKIE_NSECRETS];
1228
1229 static int tcp_msstab[] = { 0, 536, 1460, 8960 };
1230
1231 static MD5_CTX syn_ctx;
1232
1233 #define MD5Add(v)       MD5Update(&syn_ctx, (u_char *)&v, sizeof(v))
1234
1235 struct md5_add {
1236         u_int32_t laddr, faddr;
1237         u_int32_t secbits[4];
1238         u_int16_t lport, fport;
1239 };
1240
1241 #ifdef CTASSERT
1242 CTASSERT(sizeof(struct md5_add) == 28);
1243 #endif
1244
1245 /*
1246  * Consider the problem of a recreated (and retransmitted) cookie.  If the
1247  * original SYN was accepted, the connection is established.  The second
1248  * SYN is inflight, and if it arrives with an ISN that falls within the
1249  * receive window, the connection is killed.
1250  *
1251  * However, since cookies have other problems, this may not be worth
1252  * worrying about.
1253  */
1254
1255 static u_int32_t
1256 syncookie_generate(struct syncache *sc)
1257 {
1258         u_int32_t md5_buffer[4];
1259         u_int32_t data;
1260         int idx, i;
1261         struct md5_add add;
1262 #ifdef INET6
1263         const boolean_t isipv6 = sc->sc_inc.inc_isipv6;
1264 #else
1265         const boolean_t isipv6 = FALSE;
1266 #endif
1267
1268         idx = ((ticks << SYNCOOKIE_TIMESHIFT) / hz) & SYNCOOKIE_WNDMASK;
1269         if (tcp_secret[idx].ts_expire < ticks) {
1270                 for (i = 0; i < 4; i++)
1271                         tcp_secret[idx].ts_secbits[i] = karc4random();
1272                 tcp_secret[idx].ts_expire = ticks + SYNCOOKIE_TIMEOUT;
1273         }
1274         for (data = sizeof(tcp_msstab) / sizeof(int) - 1; data > 0; data--)
1275                 if (tcp_msstab[data] <= sc->sc_peer_mss)
1276                         break;
1277         data = (data << SYNCOOKIE_WNDBITS) | idx;
1278         data ^= sc->sc_irs;                             /* peer's iss */
1279         MD5Init(&syn_ctx);
1280         if (isipv6) {
1281                 MD5Add(sc->sc_inc.inc6_laddr);
1282                 MD5Add(sc->sc_inc.inc6_faddr);
1283                 add.laddr = 0;
1284                 add.faddr = 0;
1285         } else {
1286                 add.laddr = sc->sc_inc.inc_laddr.s_addr;
1287                 add.faddr = sc->sc_inc.inc_faddr.s_addr;
1288         }
1289         add.lport = sc->sc_inc.inc_lport;
1290         add.fport = sc->sc_inc.inc_fport;
1291         add.secbits[0] = tcp_secret[idx].ts_secbits[0];
1292         add.secbits[1] = tcp_secret[idx].ts_secbits[1];
1293         add.secbits[2] = tcp_secret[idx].ts_secbits[2];
1294         add.secbits[3] = tcp_secret[idx].ts_secbits[3];
1295         MD5Add(add);
1296         MD5Final((u_char *)&md5_buffer, &syn_ctx);
1297         data ^= (md5_buffer[0] & ~SYNCOOKIE_WNDMASK);
1298         return (data);
1299 }
1300
1301 static struct syncache *
1302 syncookie_lookup(struct in_conninfo *inc, struct tcphdr *th, struct socket *so)
1303 {
1304         u_int32_t md5_buffer[4];
1305         struct syncache *sc;
1306         u_int32_t data;
1307         int wnd, idx;
1308         struct md5_add add;
1309
1310         data = (th->th_ack - 1) ^ (th->th_seq - 1);     /* remove ISS */
1311         idx = data & SYNCOOKIE_WNDMASK;
1312         if (tcp_secret[idx].ts_expire < ticks ||
1313             sototcpcb(so)->ts_recent + SYNCOOKIE_TIMEOUT < ticks)
1314                 return (NULL);
1315         MD5Init(&syn_ctx);
1316 #ifdef INET6
1317         if (inc->inc_isipv6) {
1318                 MD5Add(inc->inc6_laddr);
1319                 MD5Add(inc->inc6_faddr);
1320                 add.laddr = 0;
1321                 add.faddr = 0;
1322         } else
1323 #endif
1324         {
1325                 add.laddr = inc->inc_laddr.s_addr;
1326                 add.faddr = inc->inc_faddr.s_addr;
1327         }
1328         add.lport = inc->inc_lport;
1329         add.fport = inc->inc_fport;
1330         add.secbits[0] = tcp_secret[idx].ts_secbits[0];
1331         add.secbits[1] = tcp_secret[idx].ts_secbits[1];
1332         add.secbits[2] = tcp_secret[idx].ts_secbits[2];
1333         add.secbits[3] = tcp_secret[idx].ts_secbits[3];
1334         MD5Add(add);
1335         MD5Final((u_char *)&md5_buffer, &syn_ctx);
1336         data ^= md5_buffer[0];
1337         if (data & ~SYNCOOKIE_DATAMASK)
1338                 return (NULL);
1339         data = data >> SYNCOOKIE_WNDBITS;
1340
1341         /*
1342          * Fill in the syncache values.
1343          * XXX duplicate code from syncache_add
1344          */
1345         sc = kmalloc(sizeof(struct syncache), M_SYNCACHE, M_WAITOK|M_ZERO);
1346         sc->sc_ipopts = NULL;
1347         sc->sc_inc.inc_fport = inc->inc_fport;
1348         sc->sc_inc.inc_lport = inc->inc_lport;
1349 #ifdef INET6
1350         sc->sc_inc.inc_isipv6 = inc->inc_isipv6;
1351         if (inc->inc_isipv6) {
1352                 sc->sc_inc.inc6_faddr = inc->inc6_faddr;
1353                 sc->sc_inc.inc6_laddr = inc->inc6_laddr;
1354                 sc->sc_route6.ro_rt = NULL;
1355         } else
1356 #endif
1357         {
1358                 sc->sc_inc.inc_faddr = inc->inc_faddr;
1359                 sc->sc_inc.inc_laddr = inc->inc_laddr;
1360                 sc->sc_route.ro_rt = NULL;
1361         }
1362         sc->sc_irs = th->th_seq - 1;
1363         sc->sc_iss = th->th_ack - 1;
1364         wnd = ssb_space(&so->so_rcv);
1365         wnd = imax(wnd, 0);
1366         wnd = imin(wnd, TCP_MAXWIN);
1367         sc->sc_wnd = wnd;
1368         sc->sc_flags = 0;
1369         sc->sc_rxtslot = 0;
1370         sc->sc_peer_mss = tcp_msstab[data];
1371         return (sc);
1372 }