2 * Copyright (c) 1982, 1986, 1988, 1990, 1993, 1995
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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
29 * @(#)tcp_subr.c 8.2 (Berkeley) 5/24/95
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
36 #include "opt_inet6.h"
37 #include "opt_tcpdebug.h"
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/callout.h>
42 #include <sys/kernel.h>
43 #include <sys/sysctl.h>
44 #include <sys/malloc.h>
48 #include <sys/socket.h>
49 #include <sys/socketvar.h>
51 #include <sys/syslog.h>
53 #include <sys/protosw.h>
54 #include <sys/random.h>
58 #include <net/route.h>
60 #include <net/if_var.h>
63 #include <netinet/in.h>
64 #include <netinet/in_pcb.h>
65 #include <netinet/in_systm.h>
66 #include <netinet/in_var.h>
67 #include <netinet/ip.h>
68 #include <netinet/ip_icmp.h>
69 #include <netinet/ip_var.h>
71 #include <netinet/ip6.h>
72 #include <netinet6/in6_pcb.h>
73 #include <netinet6/ip6_var.h>
74 #include <netinet6/scope6_var.h>
75 #include <netinet6/nd6.h>
77 #include <netinet/tcp.h>
78 #include <netinet/tcp_fsm.h>
79 #include <netinet/tcp_seq.h>
80 #include <netinet/tcp_timer.h>
81 #include <netinet/tcp_var.h>
83 #include <netinet6/tcp6_var.h>
85 #include <netinet/tcpip.h>
87 #include <netinet/tcp_debug.h>
90 #include <netinet6/ip6protosw.h>
93 #include <machine/in_cksum.h>
95 #include <security/mac/mac_framework.h>
97 static VNET_DEFINE(uma_zone_t, tcptw_zone);
98 #define V_tcptw_zone VNET(tcptw_zone)
102 * The timed wait queue contains references to each of the TCP sessions
103 * currently in the TIME_WAIT state. The queue pointers, including the
104 * queue pointers in each tcptw structure, are protected using the global
105 * timewait lock, which must be held over queue iteration and modification.
107 * Rules on tcptw usage:
108 * - a inpcb is always freed _after_ its tcptw
109 * - a tcptw relies on its inpcb reference counting for memory stability
110 * - a tcptw is dereferenceable only while its inpcb is locked
112 static VNET_DEFINE(TAILQ_HEAD(, tcptw), twq_2msl);
113 #define V_twq_2msl VNET(twq_2msl)
115 /* Global timewait lock */
116 static VNET_DEFINE(struct rwlock, tw_lock);
117 #define V_tw_lock VNET(tw_lock)
119 #define TW_LOCK_INIT(tw, d) rw_init_flags(&(tw), (d), 0)
120 #define TW_LOCK_DESTROY(tw) rw_destroy(&(tw))
121 #define TW_RLOCK(tw) rw_rlock(&(tw))
122 #define TW_WLOCK(tw) rw_wlock(&(tw))
123 #define TW_RUNLOCK(tw) rw_runlock(&(tw))
124 #define TW_WUNLOCK(tw) rw_wunlock(&(tw))
125 #define TW_LOCK_ASSERT(tw) rw_assert(&(tw), RA_LOCKED)
126 #define TW_RLOCK_ASSERT(tw) rw_assert(&(tw), RA_RLOCKED)
127 #define TW_WLOCK_ASSERT(tw) rw_assert(&(tw), RA_WLOCKED)
128 #define TW_UNLOCK_ASSERT(tw) rw_assert(&(tw), RA_UNLOCKED)
130 static void tcp_tw_2msl_reset(struct tcptw *, int);
131 static void tcp_tw_2msl_stop(struct tcptw *, int);
132 static int tcp_twrespond(struct tcptw *, int);
135 tcptw_auto_size(void)
140 * Max out at half the ephemeral port range so that TIME_WAIT
141 * sockets don't tie up too many ephemeral ports.
143 if (V_ipport_lastauto > V_ipport_firstauto)
144 halfrange = (V_ipport_lastauto - V_ipport_firstauto) / 2;
146 halfrange = (V_ipport_firstauto - V_ipport_lastauto) / 2;
147 /* Protect against goofy port ranges smaller than 32. */
148 return (imin(imax(halfrange, 32), maxsockets / 5));
152 sysctl_maxtcptw(SYSCTL_HANDLER_ARGS)
157 new = tcptw_auto_size();
160 error = sysctl_handle_int(oidp, &new, 0, req);
161 if (error == 0 && req->newptr)
164 uma_zone_set_max(V_tcptw_zone, maxtcptw);
169 SYSCTL_PROC(_net_inet_tcp, OID_AUTO, maxtcptw, CTLTYPE_INT|CTLFLAG_RW,
170 &maxtcptw, 0, sysctl_maxtcptw, "IU",
171 "Maximum number of compressed TCP TIME_WAIT entries");
173 VNET_DEFINE(int, nolocaltimewait) = 0;
174 #define V_nolocaltimewait VNET(nolocaltimewait)
175 SYSCTL_INT(_net_inet_tcp, OID_AUTO, nolocaltimewait, CTLFLAG_VNET | CTLFLAG_RW,
176 &VNET_NAME(nolocaltimewait), 0,
177 "Do not create compressed TCP TIME_WAIT entries for local connections");
180 tcp_tw_zone_change(void)
184 uma_zone_set_max(V_tcptw_zone, tcptw_auto_size());
191 V_tcptw_zone = uma_zcreate("tcptw", sizeof(struct tcptw),
192 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
193 TUNABLE_INT_FETCH("net.inet.tcp.maxtcptw", &maxtcptw);
195 uma_zone_set_max(V_tcptw_zone, tcptw_auto_size());
197 uma_zone_set_max(V_tcptw_zone, maxtcptw);
198 TAILQ_INIT(&V_twq_2msl);
199 TW_LOCK_INIT(V_tw_lock, "tcptw");
208 INP_INFO_RLOCK(&V_tcbinfo);
209 while ((tw = TAILQ_FIRST(&V_twq_2msl)) != NULL)
211 INP_INFO_RUNLOCK(&V_tcbinfo);
213 TW_LOCK_DESTROY(V_tw_lock);
214 uma_zdestroy(V_tcptw_zone);
219 * Move a TCP connection into TIME_WAIT state.
221 * inp is locked, and is unlocked before returning.
224 tcp_twstart(struct tcpcb *tp)
227 struct inpcb *inp = tp->t_inpcb;
231 int isipv6 = inp->inp_inc.inc_flags & INC_ISIPV6;
234 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
235 INP_WLOCK_ASSERT(inp);
237 /* A dropped inp should never transition to TIME_WAIT state. */
238 KASSERT((inp->inp_flags & INP_DROPPED) == 0, ("tcp_twstart: "
239 "(inp->inp_flags & INP_DROPPED) != 0"));
241 if (V_nolocaltimewait) {
245 error = in6_localaddr(&inp->in6p_faddr);
247 #if defined(INET6) && defined(INET)
251 error = in_localip(inp->inp_faddr);
263 * For use only by DTrace. We do not reference the state
264 * after this point so modifying it in place is not a problem.
266 tcp_state_change(tp, TCPS_TIME_WAIT);
268 tw = uma_zalloc(V_tcptw_zone, M_NOWAIT);
271 * Reached limit on total number of TIMEWAIT connections
272 * allowed. Remove a connection from TIMEWAIT queue in LRU
273 * fashion to make room for this connection.
275 * XXX: Check if it possible to always have enough room
276 * in advance based on guarantees provided by uma_zalloc().
278 tw = tcp_tw_2msl_scan(1);
287 * The tcptw will hold a reference on its inpcb until tcp_twclose
291 in_pcbref(inp); /* Reference from tw */
294 * Recover last window size sent.
296 if (SEQ_GT(tp->rcv_adv, tp->rcv_nxt))
297 tw->last_win = (tp->rcv_adv - tp->rcv_nxt) >> tp->rcv_scale;
302 * Set t_recent if timestamps are used on the connection.
304 if ((tp->t_flags & (TF_REQ_TSTMP|TF_RCVD_TSTMP|TF_NOOPT)) ==
305 (TF_REQ_TSTMP|TF_RCVD_TSTMP)) {
306 tw->t_recent = tp->ts_recent;
307 tw->ts_offset = tp->ts_offset;
313 tw->snd_nxt = tp->snd_nxt;
314 tw->rcv_nxt = tp->rcv_nxt;
317 tw->t_starttime = tp->t_starttime;
322 * be used for fin-wait-2 state also, then we may need
323 * a ts_recent from the last segment.
325 acknow = tp->t_flags & TF_ACKNOW;
328 * First, discard tcpcb state, which includes stopping its timers and
329 * freeing it. tcp_discardcb() used to also release the inpcb, but
330 * that work is now done in the caller.
332 * Note: soisdisconnected() call used to be made in tcp_discardcb(),
333 * and might not be needed here any longer.
336 so = inp->inp_socket;
337 soisdisconnected(so);
338 tw->tw_cred = crhold(so->so_cred);
340 tw->tw_so_options = so->so_options;
343 tcp_twrespond(tw, TH_ACK);
345 inp->inp_flags |= INP_TIMEWAIT;
346 TCPSTATES_INC(TCPS_TIME_WAIT);
347 tcp_tw_2msl_reset(tw, 0);
350 * If the inpcb owns the sole reference to the socket, then we can
351 * detach and free the socket as it is not needed in time wait.
353 if (inp->inp_flags & INP_SOCKREF) {
354 KASSERT(so->so_state & SS_PROTOREF,
355 ("tcp_twstart: !SS_PROTOREF"));
356 inp->inp_flags &= ~INP_SOCKREF;
359 so->so_state &= ~SS_PROTOREF;
366 * Returns 1 if the TIME_WAIT state was killed and we should start over,
367 * looking for a pcb in the listen state. Returns 0 otherwise.
370 tcp_twcheck(struct inpcb *inp, struct tcpopt *to __unused, struct tcphdr *th,
371 struct mbuf *m, int tlen)
377 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
378 INP_WLOCK_ASSERT(inp);
381 * XXXRW: Time wait state for inpcb has been recycled, but inpcb is
382 * still present. This is undesirable, but temporarily necessary
383 * until we work out how to handle inpcb's who's timewait state has
390 thflags = th->th_flags;
393 * NOTE: for FIN_WAIT_2 (to be added later),
394 * must validate sequence number before accepting RST
398 * If the segment contains RST:
399 * Drop the segment - see Stevens, vol. 2, p. 964 and
402 if (thflags & TH_RST)
406 /* PAWS not needed at the moment */
408 * RFC 1323 PAWS: If we have a timestamp reply on this segment
409 * and it's less than ts_recent, drop it.
411 if ((to.to_flags & TOF_TS) != 0 && tp->ts_recent &&
412 TSTMP_LT(to.to_tsval, tp->ts_recent)) {
413 if ((thflags & TH_ACK) == 0)
418 * ts_recent is never updated because we never accept new segments.
423 * If a new connection request is received
424 * while in TIME_WAIT, drop the old connection
425 * and start over if the sequence numbers
426 * are above the previous ones.
428 if ((thflags & TH_SYN) && SEQ_GT(th->th_seq, tw->rcv_nxt)) {
434 * Drop the segment if it does not contain an ACK.
436 if ((thflags & TH_ACK) == 0)
440 * Reset the 2MSL timer if this is a duplicate FIN.
442 if (thflags & TH_FIN) {
443 seq = th->th_seq + tlen + (thflags & TH_SYN ? 1 : 0);
444 if (seq + 1 == tw->rcv_nxt)
445 tcp_tw_2msl_reset(tw, 1);
449 * Acknowledge the segment if it has data or is not a duplicate ACK.
451 if (thflags != TH_ACK || tlen != 0 ||
452 th->th_seq != tw->rcv_nxt || th->th_ack != tw->snd_nxt)
453 tcp_twrespond(tw, TH_ACK);
461 tcp_twclose(struct tcptw *tw, int reuse)
467 * At this point, we are in one of two situations:
469 * (1) We have no socket, just an inpcb<->twtcp pair. We can free
472 * (2) We have a socket -- if we own a reference, release it and
473 * notify the socket layer.
476 KASSERT((inp->inp_flags & INP_TIMEWAIT), ("tcp_twclose: !timewait"));
477 KASSERT(intotw(inp) == tw, ("tcp_twclose: inp_ppcb != tw"));
478 INP_INFO_RLOCK_ASSERT(&V_tcbinfo); /* in_pcbfree() */
479 INP_WLOCK_ASSERT(inp);
481 tcp_tw_2msl_stop(tw, reuse);
482 inp->inp_ppcb = NULL;
485 so = inp->inp_socket;
488 * If there's a socket, handle two cases: first, we own a
489 * strong reference, which we will now release, or we don't
490 * in which case another reference exists (XXXRW: think
491 * about this more), and we don't need to take action.
493 if (inp->inp_flags & INP_SOCKREF) {
494 inp->inp_flags &= ~INP_SOCKREF;
497 KASSERT(so->so_state & SS_PROTOREF,
498 ("tcp_twclose: INP_SOCKREF && !SS_PROTOREF"));
499 so->so_state &= ~SS_PROTOREF;
503 * If we don't own the only reference, the socket and
504 * inpcb need to be left around to be handled by
505 * tcp_usr_detach() later.
511 * The socket has been already cleaned-up for us, only free the
516 TCPSTAT_INC(tcps_closed);
520 tcp_twrespond(struct tcptw *tw, int flags)
522 struct inpcb *inp = tw->tw_inpcb;
523 #if defined(INET6) || defined(INET)
524 struct tcphdr *th = NULL;
528 struct ip *ip = NULL;
530 u_int hdrlen, optlen;
531 int error = 0; /* Keep compiler happy */
534 struct ip6_hdr *ip6 = NULL;
535 int isipv6 = inp->inp_inc.inc_flags & INC_ISIPV6;
537 hdrlen = 0; /* Keep compiler happy */
539 INP_WLOCK_ASSERT(inp);
541 m = m_gethdr(M_NOWAIT, MT_DATA);
544 m->m_data += max_linkhdr;
547 mac_inpcb_create_mbuf(inp, m);
552 hdrlen = sizeof(struct ip6_hdr) + sizeof(struct tcphdr);
553 ip6 = mtod(m, struct ip6_hdr *);
554 th = (struct tcphdr *)(ip6 + 1);
555 tcpip_fillheaders(inp, ip6, th);
558 #if defined(INET6) && defined(INET)
563 hdrlen = sizeof(struct tcpiphdr);
564 ip = mtod(m, struct ip *);
565 th = (struct tcphdr *)(ip + 1);
566 tcpip_fillheaders(inp, ip, th);
572 * Send a timestamp and echo-reply if both our side and our peer
573 * have sent timestamps in our SYN's and this is not a RST.
575 if (tw->t_recent && flags == TH_ACK) {
576 to.to_flags |= TOF_TS;
577 to.to_tsval = tcp_ts_getticks() + tw->ts_offset;
578 to.to_tsecr = tw->t_recent;
580 optlen = tcp_addoptions(&to, (u_char *)(th + 1));
582 m->m_len = hdrlen + optlen;
583 m->m_pkthdr.len = m->m_len;
585 KASSERT(max_linkhdr + m->m_len <= MHLEN, ("tcptw: mbuf too small"));
587 th->th_seq = htonl(tw->snd_nxt);
588 th->th_ack = htonl(tw->rcv_nxt);
589 th->th_off = (sizeof(struct tcphdr) + optlen) >> 2;
590 th->th_flags = flags;
591 th->th_win = htons(tw->last_win);
593 m->m_pkthdr.csum_data = offsetof(struct tcphdr, th_sum);
596 m->m_pkthdr.csum_flags = CSUM_TCP_IPV6;
597 th->th_sum = in6_cksum_pseudo(ip6,
598 sizeof(struct tcphdr) + optlen, IPPROTO_TCP, 0);
599 ip6->ip6_hlim = in6_selecthlim(inp, NULL);
600 error = ip6_output(m, inp->in6p_outputopts, NULL,
601 (tw->tw_so_options & SO_DONTROUTE), NULL, NULL, inp);
604 #if defined(INET6) && defined(INET)
609 m->m_pkthdr.csum_flags = CSUM_TCP;
610 th->th_sum = in_pseudo(ip->ip_src.s_addr, ip->ip_dst.s_addr,
611 htons(sizeof(struct tcphdr) + optlen + IPPROTO_TCP));
612 ip->ip_len = htons(m->m_pkthdr.len);
613 if (V_path_mtu_discovery)
614 ip->ip_off |= htons(IP_DF);
615 error = ip_output(m, inp->inp_options, NULL,
616 ((tw->tw_so_options & SO_DONTROUTE) ? IP_ROUTETOIF : 0),
621 TCPSTAT_INC(tcps_sndacks);
623 TCPSTAT_INC(tcps_sndctrl);
624 TCPSTAT_INC(tcps_sndtotal);
629 tcp_tw_2msl_reset(struct tcptw *tw, int rearm)
632 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
633 INP_WLOCK_ASSERT(tw->tw_inpcb);
637 TAILQ_REMOVE(&V_twq_2msl, tw, tw_2msl);
638 tw->tw_time = ticks + 2 * tcp_msl;
639 TAILQ_INSERT_TAIL(&V_twq_2msl, tw, tw_2msl);
640 TW_WUNLOCK(V_tw_lock);
644 tcp_tw_2msl_stop(struct tcptw *tw, int reuse)
650 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
656 TAILQ_REMOVE(&V_twq_2msl, tw, tw_2msl);
659 TW_WUNLOCK(V_tw_lock);
664 released = in_pcbrele_wlocked(inp);
665 KASSERT(!released, ("%s: inp should not be released here", __func__));
668 uma_zfree(V_tcptw_zone, tw);
669 TCPSTATES_DEC(TCPS_TIME_WAIT);
673 tcp_tw_2msl_scan(int reuse)
681 * Exclusive pcbinfo lock is not required in reuse case even if
682 * two inpcb locks can be acquired simultaneously:
683 * - the inpcb transitioning to TIME_WAIT state in
685 * - the inpcb closed by tcp_twclose().
687 * It is because only inpcbs in FIN_WAIT2 or CLOSING states can
688 * transition in TIME_WAIT state. Then a pcbcb cannot be in
689 * TIME_WAIT list and transitioning to TIME_WAIT state at same
692 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
698 tw = TAILQ_FIRST(&V_twq_2msl);
699 if (tw == NULL || (!reuse && (tw->tw_time - ticks) > 0)) {
700 TW_RUNLOCK(V_tw_lock);
703 KASSERT(tw->tw_inpcb != NULL, ("%s: tw->tw_inpcb == NULL",
708 TW_RUNLOCK(V_tw_lock);
710 if (INP_INFO_TRY_RLOCK(&V_tcbinfo)) {
714 if (in_pcbrele_wlocked(inp)) {
715 if (__predict_true(tw == NULL)) {
716 INP_INFO_RUNLOCK(&V_tcbinfo);
719 /* This should not happen as in TIMEWAIT
720 * state the inp should not be destroyed
721 * before its tcptw. If INVARIANTS is
725 panic("%s: Panic before an infinite "
726 "loop: INP_TIMEWAIT && (INP_FREED "
727 "|| inp last reference) && tw != "
730 log(LOG_ERR, "%s: Avoid an infinite "
731 "loop: INP_TIMEWAIT && (INP_FREED "
732 "|| inp last reference) && tw != "
735 INP_INFO_RUNLOCK(&V_tcbinfo);
741 /* tcp_twclose() has already been called */
743 INP_INFO_RUNLOCK(&V_tcbinfo);
747 tcp_twclose(tw, reuse);
748 INP_INFO_RUNLOCK(&V_tcbinfo);
752 /* INP_INFO lock is busy, continue later. */
754 if (!in_pcbrele_wlocked(inp))