2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1988, 1993
5 * The Regents of the University of California.
6 * Copyright (c) 2006-2007 Robert N. M. Watson
7 * Copyright (c) 2010-2011 Juniper Networks, Inc.
10 * Portions of this software were developed by Robert N. M. Watson under
11 * contract to Juniper Networks, Inc.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * From: @(#)tcp_usrreq.c 8.2 (Berkeley) 1/3/94
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
45 #include "opt_inet6.h"
46 #include "opt_ipsec.h"
47 #include "opt_kern_tls.h"
48 #include "opt_tcpdebug.h"
50 #include <sys/param.h>
51 #include <sys/systm.h>
53 #include <sys/limits.h>
54 #include <sys/malloc.h>
55 #include <sys/refcount.h>
56 #include <sys/kernel.h>
58 #include <sys/qmath.h>
59 #include <sys/sysctl.h>
62 #include <sys/domain.h>
64 #include <sys/socket.h>
65 #include <sys/socketvar.h>
66 #include <sys/protosw.h>
69 #include <sys/stats.h>
76 #include <net/if_var.h>
77 #include <net/route.h>
80 #include <netinet/in.h>
81 #include <netinet/in_kdtrace.h>
82 #include <netinet/in_pcb.h>
83 #include <netinet/in_systm.h>
84 #include <netinet/in_var.h>
85 #include <netinet/ip_var.h>
87 #include <netinet/ip6.h>
88 #include <netinet6/in6_pcb.h>
89 #include <netinet6/ip6_var.h>
90 #include <netinet6/scope6_var.h>
92 #include <netinet/tcp.h>
93 #include <netinet/tcp_fsm.h>
94 #include <netinet/tcp_seq.h>
95 #include <netinet/tcp_timer.h>
96 #include <netinet/tcp_var.h>
97 #include <netinet/tcp_log_buf.h>
98 #include <netinet/tcpip.h>
99 #include <netinet/cc/cc.h>
100 #include <netinet/tcp_fastopen.h>
101 #include <netinet/tcp_hpts.h>
103 #include <netinet/tcp_pcap.h>
106 #include <netinet/tcp_debug.h>
109 #include <netinet/tcp_offload.h>
111 #include <netipsec/ipsec_support.h>
114 #include <vm/vm_param.h>
116 #include <vm/vm_extern.h>
117 #include <vm/vm_map.h>
118 #include <vm/vm_page.h>
121 * TCP protocol interface to socket abstraction.
124 static int tcp_connect(struct tcpcb *, struct sockaddr *,
128 static int tcp6_connect(struct tcpcb *, struct sockaddr *,
131 static void tcp_disconnect(struct tcpcb *);
132 static void tcp_usrclosed(struct tcpcb *);
133 static void tcp_fill_info(struct tcpcb *, struct tcp_info *);
135 static int tcp_pru_options_support(struct tcpcb *tp, int flags);
138 #define TCPDEBUG0 int ostate = 0
139 #define TCPDEBUG1() ostate = tp ? tp->t_state : 0
140 #define TCPDEBUG2(req) if (tp && (so->so_options & SO_DEBUG)) \
141 tcp_trace(TA_USER, ostate, tp, 0, 0, req)
145 #define TCPDEBUG2(req)
149 * tcp_require_unique port requires a globally-unique source port for each
150 * outgoing connection. The default is to require the 4-tuple to be unique.
152 VNET_DEFINE(int, tcp_require_unique_port) = 0;
153 SYSCTL_INT(_net_inet_tcp, OID_AUTO, require_unique_port,
154 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(tcp_require_unique_port), 0,
155 "Require globally-unique ephemeral port for outgoing connections");
156 #define V_tcp_require_unique_port VNET(tcp_require_unique_port)
159 * TCP attaches to socket via pru_attach(), reserving space,
160 * and an internet control block.
163 tcp_usr_attach(struct socket *so, int proto, struct thread *td)
166 struct tcpcb *tp = NULL;
171 KASSERT(inp == NULL, ("tcp_usr_attach: inp != NULL"));
174 if (so->so_snd.sb_hiwat == 0 || so->so_rcv.sb_hiwat == 0) {
175 error = soreserve(so, V_tcp_sendspace, V_tcp_recvspace);
180 so->so_rcv.sb_flags |= SB_AUTOSIZE;
181 so->so_snd.sb_flags |= SB_AUTOSIZE;
182 error = in_pcballoc(so, &V_tcbinfo);
187 if (inp->inp_vflag & INP_IPV6PROTO) {
188 inp->inp_vflag |= INP_IPV6;
189 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) == 0)
190 inp->inp_vflag |= INP_IPV4;
191 inp->in6p_hops = -1; /* use kernel default */
195 inp->inp_vflag |= INP_IPV4;
196 tp = tcp_newtcpcb(inp);
203 tp->t_state = TCPS_CLOSED;
205 TCPSTATES_INC(TCPS_CLOSED);
207 TCPDEBUG2(PRU_ATTACH);
208 TCP_PROBE2(debug__user, tp, PRU_ATTACH);
213 * tcp_usr_detach is called when the socket layer loses its final reference
214 * to the socket, be it a file descriptor reference, a reference from TCP,
215 * etc. At this point, there is only one case in which we will keep around
216 * inpcb state: time wait.
219 tcp_usr_detach(struct socket *so)
225 KASSERT(inp != NULL, ("%s: inp == NULL", __func__));
227 KASSERT(so->so_pcb == inp && inp->inp_socket == so,
228 ("%s: socket %p inp %p mismatch", __func__, so, inp));
232 if (inp->inp_flags & INP_TIMEWAIT) {
234 * There are two cases to handle: one in which the time wait
235 * state is being discarded (INP_DROPPED), and one in which
236 * this connection will remain in timewait. In the former,
237 * it is time to discard all state (except tcptw, which has
238 * already been discarded by the timewait close code, which
239 * should be further up the call stack somewhere). In the
240 * latter case, we detach from the socket, but leave the pcb
241 * present until timewait ends.
243 * XXXRW: Would it be cleaner to free the tcptw here?
245 * Astute question indeed, from twtcp perspective there are
246 * four cases to consider:
248 * #1 tcp_usr_detach is called at tcptw creation time by
249 * tcp_twstart, then do not discard the newly created tcptw
250 * and leave inpcb present until timewait ends
251 * #2 tcp_usr_detach is called at tcptw creation time by
252 * tcp_twstart, but connection is local and tw will be
253 * discarded immediately
254 * #3 tcp_usr_detach is called at timewait end (or reuse) by
255 * tcp_twclose, then the tcptw has already been discarded
256 * (or reused) and inpcb is freed here
257 * #4 tcp_usr_detach is called() after timewait ends (or reuse)
258 * (e.g. by soclose), then tcptw has already been discarded
259 * (or reused) and inpcb is freed here
261 * In all three cases the tcptw should not be freed here.
263 if (inp->inp_flags & INP_DROPPED) {
264 KASSERT(tp == NULL, ("tcp_detach: INP_TIMEWAIT && "
265 "INP_DROPPED && tp != NULL"));
274 * If the connection is not in timewait, we consider two
275 * two conditions: one in which no further processing is
276 * necessary (dropped || embryonic), and one in which TCP is
277 * not yet done, but no longer requires the socket, so the
278 * pcb will persist for the time being.
280 * XXXRW: Does the second case still occur?
282 if (inp->inp_flags & INP_DROPPED ||
283 tp->t_state < TCPS_SYN_SENT) {
296 * Give the socket an address.
299 tcp_usr_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
303 struct tcpcb *tp = NULL;
304 struct sockaddr_in *sinp;
306 sinp = (struct sockaddr_in *)nam;
307 if (nam->sa_family != AF_INET) {
309 * Preserve compatibility with old programs.
311 if (nam->sa_family != AF_UNSPEC ||
312 nam->sa_len < offsetof(struct sockaddr_in, sin_zero) ||
313 sinp->sin_addr.s_addr != INADDR_ANY)
314 return (EAFNOSUPPORT);
315 nam->sa_family = AF_INET;
317 if (nam->sa_len != sizeof(*sinp))
321 * Must check for multicast addresses and disallow binding
324 if (IN_MULTICAST(ntohl(sinp->sin_addr.s_addr)))
325 return (EAFNOSUPPORT);
329 KASSERT(inp != NULL, ("tcp_usr_bind: inp == NULL"));
331 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
337 INP_HASH_WLOCK(&V_tcbinfo);
338 error = in_pcbbind(inp, nam, td->td_ucred);
339 INP_HASH_WUNLOCK(&V_tcbinfo);
342 TCP_PROBE2(debug__user, tp, PRU_BIND);
351 tcp6_usr_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
355 struct tcpcb *tp = NULL;
356 struct sockaddr_in6 *sin6;
359 sin6 = (struct sockaddr_in6 *)nam;
360 if (nam->sa_family != AF_INET6)
361 return (EAFNOSUPPORT);
362 if (nam->sa_len != sizeof(*sin6))
366 * Must check for multicast addresses and disallow binding
369 if (IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
370 return (EAFNOSUPPORT);
374 KASSERT(inp != NULL, ("tcp6_usr_bind: inp == NULL"));
376 vflagsav = inp->inp_vflag;
377 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
383 INP_HASH_WLOCK(&V_tcbinfo);
384 inp->inp_vflag &= ~INP_IPV4;
385 inp->inp_vflag |= INP_IPV6;
387 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) == 0) {
388 if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr))
389 inp->inp_vflag |= INP_IPV4;
390 else if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr)) {
391 struct sockaddr_in sin;
393 in6_sin6_2_sin(&sin, sin6);
394 if (IN_MULTICAST(ntohl(sin.sin_addr.s_addr))) {
395 error = EAFNOSUPPORT;
396 INP_HASH_WUNLOCK(&V_tcbinfo);
399 inp->inp_vflag |= INP_IPV4;
400 inp->inp_vflag &= ~INP_IPV6;
401 error = in_pcbbind(inp, (struct sockaddr *)&sin,
403 INP_HASH_WUNLOCK(&V_tcbinfo);
408 error = in6_pcbbind(inp, nam, td->td_ucred);
409 INP_HASH_WUNLOCK(&V_tcbinfo);
412 inp->inp_vflag = vflagsav;
414 TCP_PROBE2(debug__user, tp, PRU_BIND);
422 * Prepare to accept connections.
425 tcp_usr_listen(struct socket *so, int backlog, struct thread *td)
429 struct tcpcb *tp = NULL;
433 KASSERT(inp != NULL, ("tcp_usr_listen: inp == NULL"));
435 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
442 error = solisten_proto_check(so);
447 if (inp->inp_lport == 0) {
448 INP_HASH_WLOCK(&V_tcbinfo);
449 error = in_pcbbind(inp, NULL, td->td_ucred);
450 INP_HASH_WUNLOCK(&V_tcbinfo);
453 tcp_state_change(tp, TCPS_LISTEN);
454 solisten_proto(so, backlog);
456 if ((so->so_options & SO_NO_OFFLOAD) == 0)
457 tcp_offload_listen_start(tp);
460 solisten_proto_abort(so);
464 if (IS_FASTOPEN(tp->t_flags))
465 tp->t_tfo_pending = tcp_fastopen_alloc_counter();
468 TCPDEBUG2(PRU_LISTEN);
469 TCP_PROBE2(debug__user, tp, PRU_LISTEN);
477 tcp6_usr_listen(struct socket *so, int backlog, struct thread *td)
481 struct tcpcb *tp = NULL;
486 KASSERT(inp != NULL, ("tcp6_usr_listen: inp == NULL"));
488 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
492 vflagsav = inp->inp_vflag;
496 error = solisten_proto_check(so);
501 INP_HASH_WLOCK(&V_tcbinfo);
502 if (inp->inp_lport == 0) {
503 inp->inp_vflag &= ~INP_IPV4;
504 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) == 0)
505 inp->inp_vflag |= INP_IPV4;
506 error = in6_pcbbind(inp, NULL, td->td_ucred);
508 INP_HASH_WUNLOCK(&V_tcbinfo);
510 tcp_state_change(tp, TCPS_LISTEN);
511 solisten_proto(so, backlog);
513 if ((so->so_options & SO_NO_OFFLOAD) == 0)
514 tcp_offload_listen_start(tp);
517 solisten_proto_abort(so);
521 if (IS_FASTOPEN(tp->t_flags))
522 tp->t_tfo_pending = tcp_fastopen_alloc_counter();
525 inp->inp_vflag = vflagsav;
528 TCPDEBUG2(PRU_LISTEN);
529 TCP_PROBE2(debug__user, tp, PRU_LISTEN);
537 * Initiate connection to peer.
538 * Create a template for use in transmissions on this connection.
539 * Enter SYN_SENT state, and mark socket as connecting.
540 * Start keep-alive timer, and seed output sequence space.
541 * Send initial segment on connection.
544 tcp_usr_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
546 struct epoch_tracker et;
549 struct tcpcb *tp = NULL;
550 struct sockaddr_in *sinp;
552 sinp = (struct sockaddr_in *)nam;
553 if (nam->sa_family != AF_INET)
554 return (EAFNOSUPPORT);
555 if (nam->sa_len != sizeof (*sinp))
559 * Must disallow TCP ``connections'' to multicast addresses.
561 if (IN_MULTICAST(ntohl(sinp->sin_addr.s_addr)))
562 return (EAFNOSUPPORT);
563 if (ntohl(sinp->sin_addr.s_addr) == INADDR_BROADCAST)
565 if ((error = prison_remote_ip4(td->td_ucred, &sinp->sin_addr)) != 0)
570 KASSERT(inp != NULL, ("tcp_usr_connect: inp == NULL"));
572 if (inp->inp_flags & INP_TIMEWAIT) {
576 if (inp->inp_flags & INP_DROPPED) {
577 error = ECONNREFUSED;
580 if (SOLISTENING(so)) {
587 if ((error = tcp_connect(tp, nam, td)) != 0)
590 if (registered_toedevs > 0 &&
591 (so->so_options & SO_NO_OFFLOAD) == 0 &&
592 (error = tcp_offload_connect(so, nam)) == 0)
595 tcp_timer_activate(tp, TT_KEEP, TP_KEEPINIT(tp));
596 error = tcp_output(tp);
597 KASSERT(error >= 0, ("TCP stack %s requested tcp_drop(%p) at connect()",
598 tp->t_fb->tfb_tcp_block_name, tp));
602 TCPDEBUG2(PRU_CONNECT);
603 TCP_PROBE2(debug__user, tp, PRU_CONNECT);
611 tcp6_usr_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
613 struct epoch_tracker et;
616 struct tcpcb *tp = NULL;
617 struct sockaddr_in6 *sin6;
623 sin6 = (struct sockaddr_in6 *)nam;
624 if (nam->sa_family != AF_INET6)
625 return (EAFNOSUPPORT);
626 if (nam->sa_len != sizeof (*sin6))
630 * Must disallow TCP ``connections'' to multicast addresses.
632 if (IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
633 return (EAFNOSUPPORT);
636 KASSERT(inp != NULL, ("tcp6_usr_connect: inp == NULL"));
638 vflagsav = inp->inp_vflag;
639 incflagsav = inp->inp_inc.inc_flags;
640 if (inp->inp_flags & INP_TIMEWAIT) {
644 if (inp->inp_flags & INP_DROPPED) {
645 error = ECONNREFUSED;
648 if (SOLISTENING(so)) {
656 * XXXRW: Some confusion: V4/V6 flags relate to binding, and
657 * therefore probably require the hash lock, which isn't held here.
658 * Is this a significant problem?
660 if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr)) {
661 struct sockaddr_in sin;
663 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) != 0) {
667 if ((inp->inp_vflag & INP_IPV4) == 0) {
668 error = EAFNOSUPPORT;
672 in6_sin6_2_sin(&sin, sin6);
673 if (IN_MULTICAST(ntohl(sin.sin_addr.s_addr))) {
674 error = EAFNOSUPPORT;
677 if (ntohl(sin.sin_addr.s_addr) == INADDR_BROADCAST) {
681 if ((error = prison_remote_ip4(td->td_ucred,
682 &sin.sin_addr)) != 0)
684 inp->inp_vflag |= INP_IPV4;
685 inp->inp_vflag &= ~INP_IPV6;
687 if ((error = tcp_connect(tp, (struct sockaddr *)&sin, td)) != 0)
690 if (registered_toedevs > 0 &&
691 (so->so_options & SO_NO_OFFLOAD) == 0 &&
692 (error = tcp_offload_connect(so, nam)) == 0)
695 error = tcp_output(tp);
698 if ((inp->inp_vflag & INP_IPV6) == 0) {
699 error = EAFNOSUPPORT;
704 if ((error = prison_remote_ip6(td->td_ucred, &sin6->sin6_addr)) != 0)
706 inp->inp_vflag &= ~INP_IPV4;
707 inp->inp_vflag |= INP_IPV6;
708 inp->inp_inc.inc_flags |= INC_ISIPV6;
709 if ((error = tcp6_connect(tp, nam, td)) != 0)
712 if (registered_toedevs > 0 &&
713 (so->so_options & SO_NO_OFFLOAD) == 0 &&
714 (error = tcp_offload_connect(so, nam)) == 0)
717 tcp_timer_activate(tp, TT_KEEP, TP_KEEPINIT(tp));
719 error = tcp_output(tp);
725 KASSERT(error >= 0, ("TCP stack %s requested tcp_drop(%p) at connect()",
726 tp->t_fb->tfb_tcp_block_name, tp));
728 * If the implicit bind in the connect call fails, restore
729 * the flags we modified.
731 if (error != 0 && inp->inp_lport == 0) {
732 inp->inp_vflag = vflagsav;
733 inp->inp_inc.inc_flags = incflagsav;
736 TCPDEBUG2(PRU_CONNECT);
737 TCP_PROBE2(debug__user, tp, PRU_CONNECT);
744 * Initiate disconnect from peer.
745 * If connection never passed embryonic stage, just drop;
746 * else if don't need to let data drain, then can just drop anyways,
747 * else have to begin TCP shutdown process: mark socket disconnecting,
748 * drain unread data, state switch to reflect user close, and
749 * send segment (e.g. FIN) to peer. Socket will be really disconnected
750 * when peer sends FIN and acks ours.
752 * SHOULD IMPLEMENT LATER PRU_CONNECT VIA REALLOC TCPCB.
755 tcp_usr_disconnect(struct socket *so)
758 struct tcpcb *tp = NULL;
759 struct epoch_tracker et;
765 KASSERT(inp != NULL, ("tcp_usr_disconnect: inp == NULL"));
767 if (inp->inp_flags & INP_TIMEWAIT)
769 if (inp->inp_flags & INP_DROPPED) {
777 TCPDEBUG2(PRU_DISCONNECT);
778 TCP_PROBE2(debug__user, tp, PRU_DISCONNECT);
786 * Accept a connection. Essentially all the work is done at higher levels;
787 * just return the address of the peer, storing through addr.
790 tcp_usr_accept(struct socket *so, struct sockaddr **nam)
793 struct inpcb *inp = NULL;
794 struct tcpcb *tp = NULL;
799 if (so->so_state & SS_ISDISCONNECTED)
800 return (ECONNABORTED);
803 KASSERT(inp != NULL, ("tcp_usr_accept: inp == NULL"));
805 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
806 error = ECONNABORTED;
813 * We inline in_getpeeraddr and COMMON_END here, so that we can
814 * copy the data of interest and defer the malloc until after we
817 port = inp->inp_fport;
818 addr = inp->inp_faddr;
821 TCPDEBUG2(PRU_ACCEPT);
822 TCP_PROBE2(debug__user, tp, PRU_ACCEPT);
825 *nam = in_sockaddr(port, &addr);
832 tcp6_usr_accept(struct socket *so, struct sockaddr **nam)
834 struct inpcb *inp = NULL;
836 struct tcpcb *tp = NULL;
838 struct in6_addr addr6;
839 struct epoch_tracker et;
844 if (so->so_state & SS_ISDISCONNECTED)
845 return (ECONNABORTED);
848 KASSERT(inp != NULL, ("tcp6_usr_accept: inp == NULL"));
851 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
852 error = ECONNABORTED;
859 * We inline in6_mapped_peeraddr and COMMON_END here, so that we can
860 * copy the data of interest and defer the malloc until after we
863 if (inp->inp_vflag & INP_IPV4) {
865 port = inp->inp_fport;
866 addr = inp->inp_faddr;
868 port = inp->inp_fport;
869 addr6 = inp->in6p_faddr;
873 TCPDEBUG2(PRU_ACCEPT);
874 TCP_PROBE2(debug__user, tp, PRU_ACCEPT);
879 *nam = in6_v4mapsin6_sockaddr(port, &addr);
881 *nam = in6_sockaddr(port, &addr6);
888 * Mark the connection as being incapable of further output.
891 tcp_usr_shutdown(struct socket *so)
895 struct tcpcb *tp = NULL;
896 struct epoch_tracker et;
900 KASSERT(inp != NULL, ("inp == NULL"));
902 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
911 if (!(inp->inp_flags & INP_DROPPED))
912 error = tcp_output_nodrop(tp);
913 TCPDEBUG2(PRU_SHUTDOWN);
914 TCP_PROBE2(debug__user, tp, PRU_SHUTDOWN);
915 error = tcp_unlock_or_drop(tp, error);
922 * After a receive, possibly send window update to peer.
925 tcp_usr_rcvd(struct socket *so, int flags)
927 struct epoch_tracker et;
929 struct tcpcb *tp = NULL;
930 int outrv = 0, error = 0;
934 KASSERT(inp != NULL, ("tcp_usr_rcvd: inp == NULL"));
936 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
944 * For passively-created TFO connections, don't attempt a window
945 * update while still in SYN_RECEIVED as this may trigger an early
946 * SYN|ACK. It is preferable to have the SYN|ACK be sent along with
947 * application response data, or failing that, when the DELACK timer
950 if (IS_FASTOPEN(tp->t_flags) &&
951 (tp->t_state == TCPS_SYN_RECEIVED))
954 if (tp->t_flags & TF_TOE)
955 tcp_offload_rcvd(tp);
958 outrv = tcp_output_nodrop(tp);
961 TCP_PROBE2(debug__user, tp, PRU_RCVD);
962 (void) tcp_unlock_or_drop(tp, outrv);
968 * Do a send by putting data in output queue and updating urgent
969 * marker if URG set. Possibly send more data. Unlike the other
970 * pru_*() routines, the mbuf chains are our responsibility. We
971 * must either enqueue them or free them. The other pru_* routines
972 * generally are caller-frees.
975 tcp_usr_send(struct socket *so, int flags, struct mbuf *m,
976 struct sockaddr *nam, struct mbuf *control, struct thread *td)
978 struct epoch_tracker et;
981 struct tcpcb *tp = NULL;
984 struct sockaddr_in sin;
986 struct sockaddr_in *sinp;
997 * We require the pcbinfo "read lock" if we will close the socket
998 * as part of this call.
1000 NET_EPOCH_ENTER(et);
1001 inp = sotoinpcb(so);
1002 KASSERT(inp != NULL, ("tcp_usr_send: inp == NULL"));
1004 tp = intotcpcb(inp);
1005 vflagsav = inp->inp_vflag;
1006 incflagsav = inp->inp_inc.inc_flags;
1007 restoreflags = false;
1008 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1014 if (control != NULL) {
1015 /* TCP doesn't do control messages (rights, creds, etc) */
1016 if (control->m_len) {
1021 m_freem(control); /* empty control, just free it */
1024 if ((flags & PRUS_OOB) != 0 &&
1025 (error = tcp_pru_options_support(tp, PRUS_OOB)) != 0)
1029 if (nam != NULL && tp->t_state < TCPS_SYN_SENT) {
1030 if (tp->t_state == TCPS_LISTEN) {
1034 switch (nam->sa_family) {
1037 sinp = (struct sockaddr_in *)nam;
1038 if (sinp->sin_len != sizeof(struct sockaddr_in)) {
1042 if ((inp->inp_vflag & INP_IPV6) != 0) {
1043 error = EAFNOSUPPORT;
1046 if (IN_MULTICAST(ntohl(sinp->sin_addr.s_addr))) {
1047 error = EAFNOSUPPORT;
1050 if (ntohl(sinp->sin_addr.s_addr) == INADDR_BROADCAST) {
1054 if ((error = prison_remote_ip4(td->td_ucred,
1065 struct sockaddr_in6 *sin6;
1067 sin6 = (struct sockaddr_in6 *)nam;
1068 if (sin6->sin6_len != sizeof(*sin6)) {
1072 if ((inp->inp_vflag & INP_IPV6PROTO) == 0) {
1073 error = EAFNOSUPPORT;
1076 if (IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr)) {
1077 error = EAFNOSUPPORT;
1080 if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr)) {
1082 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) != 0) {
1086 if ((inp->inp_vflag & INP_IPV4) == 0) {
1087 error = EAFNOSUPPORT;
1090 restoreflags = true;
1091 inp->inp_vflag &= ~INP_IPV6;
1093 in6_sin6_2_sin(sinp, sin6);
1095 ntohl(sinp->sin_addr.s_addr))) {
1096 error = EAFNOSUPPORT;
1099 if ((error = prison_remote_ip4(td->td_ucred,
1104 error = EAFNOSUPPORT;
1108 if ((inp->inp_vflag & INP_IPV6) == 0) {
1109 error = EAFNOSUPPORT;
1112 restoreflags = true;
1113 inp->inp_vflag &= ~INP_IPV4;
1114 inp->inp_inc.inc_flags |= INC_ISIPV6;
1115 if ((error = prison_remote_ip6(td->td_ucred,
1124 error = EAFNOSUPPORT;
1128 if (!(flags & PRUS_OOB)) {
1129 sbappendstream(&so->so_snd, m, flags);
1131 if (nam && tp->t_state < TCPS_SYN_SENT) {
1132 KASSERT(tp->t_state == TCPS_CLOSED,
1133 ("%s: tp %p is listening", __func__, tp));
1136 * Do implied connect if not yet connected,
1137 * initialize window to default value, and
1138 * initialize maxseg using peer's cached MSS.
1142 error = tcp6_connect(tp, nam, td);
1144 #if defined(INET6) && defined(INET)
1148 error = tcp_connect(tp,
1149 (struct sockaddr *)sinp, td);
1152 * The bind operation in tcp_connect succeeded. We
1153 * no longer want to restore the flags if later
1156 if (error == 0 || inp->inp_lport != 0)
1157 restoreflags = false;
1160 /* m is freed if PRUS_NOTREADY is unset. */
1161 sbflush(&so->so_snd);
1164 if (IS_FASTOPEN(tp->t_flags))
1165 tcp_fastopen_connect(tp);
1167 tp->snd_wnd = TTCP_CLIENT_SND_WND;
1171 if (flags & PRUS_EOF) {
1173 * Close the send side of the connection after
1179 if (TCPS_HAVEESTABLISHED(tp->t_state) &&
1180 ((tp->t_flags2 & TF2_FBYTES_COMPLETE) == 0) &&
1181 (tp->t_fbyte_out == 0) &&
1182 (so->so_snd.sb_ccc > 0)) {
1183 tp->t_fbyte_out = ticks;
1184 if (tp->t_fbyte_out == 0)
1185 tp->t_fbyte_out = 1;
1186 if (tp->t_fbyte_out && tp->t_fbyte_in)
1187 tp->t_flags2 |= TF2_FBYTES_COMPLETE;
1189 if (!(inp->inp_flags & INP_DROPPED) &&
1190 !(flags & PRUS_NOTREADY)) {
1191 if (flags & PRUS_MORETOCOME)
1192 tp->t_flags |= TF_MORETOCOME;
1193 error = tcp_output_nodrop(tp);
1194 if (flags & PRUS_MORETOCOME)
1195 tp->t_flags &= ~TF_MORETOCOME;
1199 * XXXRW: PRUS_EOF not implemented with PRUS_OOB?
1201 SOCKBUF_LOCK(&so->so_snd);
1202 if (sbspace(&so->so_snd) < -512) {
1203 SOCKBUF_UNLOCK(&so->so_snd);
1208 * According to RFC961 (Assigned Protocols),
1209 * the urgent pointer points to the last octet
1210 * of urgent data. We continue, however,
1211 * to consider it to indicate the first octet
1212 * of data past the urgent section.
1213 * Otherwise, snd_up should be one lower.
1215 sbappendstream_locked(&so->so_snd, m, flags);
1216 SOCKBUF_UNLOCK(&so->so_snd);
1218 if (nam && tp->t_state < TCPS_SYN_SENT) {
1220 * Do implied connect if not yet connected,
1221 * initialize window to default value, and
1222 * initialize maxseg using peer's cached MSS.
1226 * Not going to contemplate SYN|URG
1228 if (IS_FASTOPEN(tp->t_flags))
1229 tp->t_flags &= ~TF_FASTOPEN;
1232 error = tcp6_connect(tp, nam, td);
1234 #if defined(INET6) && defined(INET)
1238 error = tcp_connect(tp,
1239 (struct sockaddr *)sinp, td);
1242 * The bind operation in tcp_connect succeeded. We
1243 * no longer want to restore the flags if later
1246 if (error == 0 || inp->inp_lport != 0)
1247 restoreflags = false;
1250 /* m is freed if PRUS_NOTREADY is unset. */
1251 sbflush(&so->so_snd);
1254 tp->snd_wnd = TTCP_CLIENT_SND_WND;
1257 tp->snd_up = tp->snd_una + sbavail(&so->so_snd);
1258 if ((flags & PRUS_NOTREADY) == 0) {
1259 tp->t_flags |= TF_FORCEDATA;
1260 error = tcp_output_nodrop(tp);
1261 tp->t_flags &= ~TF_FORCEDATA;
1264 TCP_LOG_EVENT(tp, NULL,
1265 &inp->inp_socket->so_rcv,
1266 &inp->inp_socket->so_snd,
1267 TCP_LOG_USERSEND, error,
1272 * In case of PRUS_NOTREADY, the caller or tcp_usr_ready() is
1273 * responsible for freeing memory.
1275 if (m != NULL && (flags & PRUS_NOTREADY) == 0)
1279 * If the request was unsuccessful and we changed flags,
1280 * restore the original flags.
1282 if (error != 0 && restoreflags) {
1283 inp->inp_vflag = vflagsav;
1284 inp->inp_inc.inc_flags = incflagsav;
1286 TCPDEBUG2((flags & PRUS_OOB) ? PRU_SENDOOB :
1287 ((flags & PRUS_EOF) ? PRU_SEND_EOF : PRU_SEND));
1288 TCP_PROBE2(debug__user, tp, (flags & PRUS_OOB) ? PRU_SENDOOB :
1289 ((flags & PRUS_EOF) ? PRU_SEND_EOF : PRU_SEND));
1290 error = tcp_unlock_or_drop(tp, error);
1296 tcp_usr_ready(struct socket *so, struct mbuf *m, int count)
1298 struct epoch_tracker et;
1303 inp = sotoinpcb(so);
1305 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1307 mb_free_notready(m, count);
1308 return (ECONNRESET);
1310 tp = intotcpcb(inp);
1312 SOCKBUF_LOCK(&so->so_snd);
1313 error = sbready(&so->so_snd, m, count);
1314 SOCKBUF_UNLOCK(&so->so_snd);
1319 NET_EPOCH_ENTER(et);
1320 error = tcp_output_unlock(tp);
1327 * Abort the TCP. Drop the connection abruptly.
1330 tcp_usr_abort(struct socket *so)
1333 struct tcpcb *tp = NULL;
1334 struct epoch_tracker et;
1337 inp = sotoinpcb(so);
1338 KASSERT(inp != NULL, ("tcp_usr_abort: inp == NULL"));
1340 NET_EPOCH_ENTER(et);
1342 KASSERT(inp->inp_socket != NULL,
1343 ("tcp_usr_abort: inp_socket == NULL"));
1346 * If we still have full TCP state, and we're not dropped, drop.
1348 if (!(inp->inp_flags & INP_TIMEWAIT) &&
1349 !(inp->inp_flags & INP_DROPPED)) {
1350 tp = intotcpcb(inp);
1352 tp = tcp_drop(tp, ECONNABORTED);
1355 TCPDEBUG2(PRU_ABORT);
1356 TCP_PROBE2(debug__user, tp, PRU_ABORT);
1358 if (!(inp->inp_flags & INP_DROPPED)) {
1360 so->so_state |= SS_PROTOREF;
1362 inp->inp_flags |= INP_SOCKREF;
1370 * TCP socket is closed. Start friendly disconnect.
1373 tcp_usr_close(struct socket *so)
1376 struct tcpcb *tp = NULL;
1377 struct epoch_tracker et;
1380 inp = sotoinpcb(so);
1381 KASSERT(inp != NULL, ("tcp_usr_close: inp == NULL"));
1383 NET_EPOCH_ENTER(et);
1385 KASSERT(inp->inp_socket != NULL,
1386 ("tcp_usr_close: inp_socket == NULL"));
1389 * If we still have full TCP state, and we're not dropped, initiate
1392 if (!(inp->inp_flags & INP_TIMEWAIT) &&
1393 !(inp->inp_flags & INP_DROPPED)) {
1394 tp = intotcpcb(inp);
1397 TCPDEBUG2(PRU_CLOSE);
1398 TCP_PROBE2(debug__user, tp, PRU_CLOSE);
1400 if (!(inp->inp_flags & INP_DROPPED)) {
1402 so->so_state |= SS_PROTOREF;
1404 inp->inp_flags |= INP_SOCKREF;
1411 tcp_pru_options_support(struct tcpcb *tp, int flags)
1414 * If the specific TCP stack has a pru_options
1415 * specified then it does not always support
1416 * all the PRU_XX options and we must ask it.
1417 * If the function is not specified then all
1418 * of the PRU_XX options are supported.
1422 if (tp->t_fb->tfb_pru_options) {
1423 ret = (*tp->t_fb->tfb_pru_options)(tp, flags);
1429 * Receive out-of-band data.
1432 tcp_usr_rcvoob(struct socket *so, struct mbuf *m, int flags)
1436 struct tcpcb *tp = NULL;
1439 inp = sotoinpcb(so);
1440 KASSERT(inp != NULL, ("tcp_usr_rcvoob: inp == NULL"));
1442 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1446 tp = intotcpcb(inp);
1447 error = tcp_pru_options_support(tp, PRUS_OOB);
1452 if ((so->so_oobmark == 0 &&
1453 (so->so_rcv.sb_state & SBS_RCVATMARK) == 0) ||
1454 so->so_options & SO_OOBINLINE ||
1455 tp->t_oobflags & TCPOOB_HADDATA) {
1459 if ((tp->t_oobflags & TCPOOB_HAVEDATA) == 0) {
1460 error = EWOULDBLOCK;
1464 *mtod(m, caddr_t) = tp->t_iobc;
1465 if ((flags & MSG_PEEK) == 0)
1466 tp->t_oobflags ^= (TCPOOB_HAVEDATA | TCPOOB_HADDATA);
1469 TCPDEBUG2(PRU_RCVOOB);
1470 TCP_PROBE2(debug__user, tp, PRU_RCVOOB);
1476 struct pr_usrreqs tcp_usrreqs = {
1477 .pru_abort = tcp_usr_abort,
1478 .pru_accept = tcp_usr_accept,
1479 .pru_attach = tcp_usr_attach,
1480 .pru_bind = tcp_usr_bind,
1481 .pru_connect = tcp_usr_connect,
1482 .pru_control = in_control,
1483 .pru_detach = tcp_usr_detach,
1484 .pru_disconnect = tcp_usr_disconnect,
1485 .pru_listen = tcp_usr_listen,
1486 .pru_peeraddr = in_getpeeraddr,
1487 .pru_rcvd = tcp_usr_rcvd,
1488 .pru_rcvoob = tcp_usr_rcvoob,
1489 .pru_send = tcp_usr_send,
1490 .pru_ready = tcp_usr_ready,
1491 .pru_shutdown = tcp_usr_shutdown,
1492 .pru_sockaddr = in_getsockaddr,
1493 .pru_sosetlabel = in_pcbsosetlabel,
1494 .pru_close = tcp_usr_close,
1499 struct pr_usrreqs tcp6_usrreqs = {
1500 .pru_abort = tcp_usr_abort,
1501 .pru_accept = tcp6_usr_accept,
1502 .pru_attach = tcp_usr_attach,
1503 .pru_bind = tcp6_usr_bind,
1504 .pru_connect = tcp6_usr_connect,
1505 .pru_control = in6_control,
1506 .pru_detach = tcp_usr_detach,
1507 .pru_disconnect = tcp_usr_disconnect,
1508 .pru_listen = tcp6_usr_listen,
1509 .pru_peeraddr = in6_mapped_peeraddr,
1510 .pru_rcvd = tcp_usr_rcvd,
1511 .pru_rcvoob = tcp_usr_rcvoob,
1512 .pru_send = tcp_usr_send,
1513 .pru_ready = tcp_usr_ready,
1514 .pru_shutdown = tcp_usr_shutdown,
1515 .pru_sockaddr = in6_mapped_sockaddr,
1516 .pru_sosetlabel = in_pcbsosetlabel,
1517 .pru_close = tcp_usr_close,
1523 * Common subroutine to open a TCP connection to remote host specified
1524 * by struct sockaddr_in in mbuf *nam. Call in_pcbbind to assign a local
1525 * port number if needed. Call in_pcbconnect_setup to do the routing and
1526 * to choose a local host address (interface). If there is an existing
1527 * incarnation of the same connection in TIME-WAIT state and if the remote
1528 * host was sending CC options and if the connection duration was < MSL, then
1529 * truncate the previous TIME-WAIT state and proceed.
1530 * Initialize connection parameters and enter SYN-SENT state.
1533 tcp_connect(struct tcpcb *tp, struct sockaddr *nam, struct thread *td)
1535 struct inpcb *inp = tp->t_inpcb, *oinp;
1536 struct socket *so = inp->inp_socket;
1537 struct in_addr laddr;
1542 INP_WLOCK_ASSERT(inp);
1543 INP_HASH_WLOCK(&V_tcbinfo);
1545 if (V_tcp_require_unique_port && inp->inp_lport == 0) {
1546 error = in_pcbbind(inp, (struct sockaddr *)0, td->td_ucred);
1552 * Cannot simply call in_pcbconnect, because there might be an
1553 * earlier incarnation of this same connection still in
1554 * TIME_WAIT state, creating an ADDRINUSE error.
1556 laddr = inp->inp_laddr;
1557 lport = inp->inp_lport;
1558 error = in_pcbconnect_setup(inp, nam, &laddr.s_addr, &lport,
1559 &inp->inp_faddr.s_addr, &inp->inp_fport, &oinp, td->td_ucred);
1560 if (error && oinp == NULL)
1566 /* Handle initial bind if it hadn't been done in advance. */
1567 if (inp->inp_lport == 0) {
1568 inp->inp_lport = lport;
1569 if (in_pcbinshash(inp) != 0) {
1575 inp->inp_laddr = laddr;
1577 INP_HASH_WUNLOCK(&V_tcbinfo);
1580 * Compute window scaling to request:
1581 * Scale to fit into sweet spot. See tcp_syncache.c.
1582 * XXX: This should move to tcp_output().
1584 while (tp->request_r_scale < TCP_MAX_WINSHIFT &&
1585 (TCP_MAXWIN << tp->request_r_scale) < sb_max)
1586 tp->request_r_scale++;
1589 TCPSTAT_INC(tcps_connattempt);
1590 tcp_state_change(tp, TCPS_SYN_SENT);
1591 tp->iss = tcp_new_isn(&inp->inp_inc);
1592 if (tp->t_flags & TF_REQ_TSTMP)
1593 tp->ts_offset = tcp_new_ts_offset(&inp->inp_inc);
1594 tcp_sendseqinit(tp);
1599 INP_HASH_WUNLOCK(&V_tcbinfo);
1606 tcp6_connect(struct tcpcb *tp, struct sockaddr *nam, struct thread *td)
1608 struct inpcb *inp = tp->t_inpcb;
1611 INP_WLOCK_ASSERT(inp);
1612 INP_HASH_WLOCK(&V_tcbinfo);
1614 if (V_tcp_require_unique_port && inp->inp_lport == 0) {
1615 error = in6_pcbbind(inp, (struct sockaddr *)0, td->td_ucred);
1619 error = in6_pcbconnect(inp, nam, td->td_ucred);
1622 INP_HASH_WUNLOCK(&V_tcbinfo);
1624 /* Compute window scaling to request. */
1625 while (tp->request_r_scale < TCP_MAX_WINSHIFT &&
1626 (TCP_MAXWIN << tp->request_r_scale) < sb_max)
1627 tp->request_r_scale++;
1629 soisconnecting(inp->inp_socket);
1630 TCPSTAT_INC(tcps_connattempt);
1631 tcp_state_change(tp, TCPS_SYN_SENT);
1632 tp->iss = tcp_new_isn(&inp->inp_inc);
1633 if (tp->t_flags & TF_REQ_TSTMP)
1634 tp->ts_offset = tcp_new_ts_offset(&inp->inp_inc);
1635 tcp_sendseqinit(tp);
1640 INP_HASH_WUNLOCK(&V_tcbinfo);
1646 * Export TCP internal state information via a struct tcp_info, based on the
1647 * Linux 2.6 API. Not ABI compatible as our constants are mapped differently
1648 * (TCP state machine, etc). We export all information using FreeBSD-native
1649 * constants -- for example, the numeric values for tcpi_state will differ
1653 tcp_fill_info(struct tcpcb *tp, struct tcp_info *ti)
1656 INP_WLOCK_ASSERT(tp->t_inpcb);
1657 bzero(ti, sizeof(*ti));
1659 ti->tcpi_state = tp->t_state;
1660 if ((tp->t_flags & TF_REQ_TSTMP) && (tp->t_flags & TF_RCVD_TSTMP))
1661 ti->tcpi_options |= TCPI_OPT_TIMESTAMPS;
1662 if (tp->t_flags & TF_SACK_PERMIT)
1663 ti->tcpi_options |= TCPI_OPT_SACK;
1664 if ((tp->t_flags & TF_REQ_SCALE) && (tp->t_flags & TF_RCVD_SCALE)) {
1665 ti->tcpi_options |= TCPI_OPT_WSCALE;
1666 ti->tcpi_snd_wscale = tp->snd_scale;
1667 ti->tcpi_rcv_wscale = tp->rcv_scale;
1669 if (tp->t_flags2 & TF2_ECN_PERMIT)
1670 ti->tcpi_options |= TCPI_OPT_ECN;
1672 ti->tcpi_rto = tp->t_rxtcur * tick;
1673 ti->tcpi_last_data_recv = ((uint32_t)ticks - tp->t_rcvtime) * tick;
1674 ti->tcpi_rtt = ((u_int64_t)tp->t_srtt * tick) >> TCP_RTT_SHIFT;
1675 ti->tcpi_rttvar = ((u_int64_t)tp->t_rttvar * tick) >> TCP_RTTVAR_SHIFT;
1677 ti->tcpi_snd_ssthresh = tp->snd_ssthresh;
1678 ti->tcpi_snd_cwnd = tp->snd_cwnd;
1681 * FreeBSD-specific extension fields for tcp_info.
1683 ti->tcpi_rcv_space = tp->rcv_wnd;
1684 ti->tcpi_rcv_nxt = tp->rcv_nxt;
1685 ti->tcpi_snd_wnd = tp->snd_wnd;
1686 ti->tcpi_snd_bwnd = 0; /* Unused, kept for compat. */
1687 ti->tcpi_snd_nxt = tp->snd_nxt;
1688 ti->tcpi_snd_mss = tp->t_maxseg;
1689 ti->tcpi_rcv_mss = tp->t_maxseg;
1690 ti->tcpi_snd_rexmitpack = tp->t_sndrexmitpack;
1691 ti->tcpi_rcv_ooopack = tp->t_rcvoopack;
1692 ti->tcpi_snd_zerowin = tp->t_sndzerowin;
1694 if (tp->t_flags & TF_TOE) {
1695 ti->tcpi_options |= TCPI_OPT_TOE;
1696 tcp_offload_tcp_info(tp, ti);
1702 * tcp_ctloutput() must drop the inpcb lock before performing copyin on
1703 * socket option arguments. When it re-acquires the lock after the copy, it
1704 * has to revalidate that the connection is still valid for the socket
1707 #define INP_WLOCK_RECHECK_CLEANUP(inp, cleanup) do { \
1709 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) { \
1712 return (ECONNRESET); \
1714 tp = intotcpcb(inp); \
1716 #define INP_WLOCK_RECHECK(inp) INP_WLOCK_RECHECK_CLEANUP((inp), /* noop */)
1719 tcp_ctloutput_set(struct inpcb *inp, struct sockopt *sopt)
1721 struct tcpcb *tp = intotcpcb(inp);
1724 MPASS(sopt->sopt_dir == SOPT_SET);
1726 if (sopt->sopt_level != IPPROTO_TCP) {
1728 if (inp->inp_vflag & INP_IPV6PROTO)
1729 error = ip6_ctloutput(inp->inp_socket, sopt);
1731 #if defined(INET6) && defined(INET)
1735 error = ip_ctloutput(inp->inp_socket, sopt);
1738 * When an IP-level socket option affects TCP, pass control
1739 * down to stack tfb_tcp_ctloutput, otherwise return what
1740 * IP level returned.
1742 switch (sopt->sopt_level) {
1745 if ((inp->inp_vflag & INP_IPV6PROTO) == 0)
1747 switch (sopt->sopt_name) {
1749 /* Notify tcp stacks that care (e.g. RACK). */
1751 case IPV6_USE_MIN_MTU:
1752 /* Update t_maxseg accordingly. */
1761 switch (sopt->sopt_name) {
1764 /* Notify tcp stacks that care (e.g. RACK). */
1774 } else if (sopt->sopt_name == TCP_FUNCTION_BLK) {
1776 * Protect the TCP option TCP_FUNCTION_BLK so
1777 * that a sub-function can *never* overwrite this.
1779 struct tcp_function_set fsn;
1780 struct tcp_function_block *blk;
1782 error = sooptcopyin(sopt, &fsn, sizeof fsn, sizeof fsn);
1787 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1789 return (ECONNRESET);
1791 tp = intotcpcb(inp);
1793 blk = find_and_ref_tcp_functions(&fsn);
1798 if (tp->t_fb == blk) {
1799 /* You already have this */
1800 refcount_release(&blk->tfb_refcnt);
1804 if (tp->t_state != TCPS_CLOSED) {
1806 * The user has advanced the state
1807 * past the initial point, we may not
1808 * be able to switch.
1810 if (blk->tfb_tcp_handoff_ok != NULL) {
1812 * Does the stack provide a
1813 * query mechanism, if so it may
1814 * still be possible?
1816 error = (*blk->tfb_tcp_handoff_ok)(tp);
1820 refcount_release(&blk->tfb_refcnt);
1825 if (blk->tfb_flags & TCP_FUNC_BEING_REMOVED) {
1826 refcount_release(&blk->tfb_refcnt);
1831 * Release the old refcnt, the
1832 * lookup acquired a ref on the
1835 if (tp->t_fb->tfb_tcp_fb_fini) {
1836 struct epoch_tracker et;
1838 * Tell the stack to cleanup with 0 i.e.
1839 * the tcb is not going away.
1841 NET_EPOCH_ENTER(et);
1842 (*tp->t_fb->tfb_tcp_fb_fini)(tp, 0);
1846 /* Assure that we are not on any hpts */
1847 tcp_hpts_remove(tp->t_inpcb);
1849 if (blk->tfb_tcp_fb_init) {
1850 error = (*blk->tfb_tcp_fb_init)(tp);
1852 refcount_release(&blk->tfb_refcnt);
1853 if (tp->t_fb->tfb_tcp_fb_init) {
1854 if((*tp->t_fb->tfb_tcp_fb_init)(tp) != 0) {
1855 /* Fall back failed, drop the connection */
1857 soabort(inp->inp_socket);
1864 refcount_release(&tp->t_fb->tfb_refcnt);
1867 if (tp->t_flags & TF_TOE) {
1868 tcp_offload_ctloutput(tp, sopt->sopt_dir,
1878 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1880 return (ECONNRESET);
1882 tp = intotcpcb(inp);
1884 /* Pass in the INP locked, caller must unlock it. */
1885 return (tp->t_fb->tfb_tcp_ctloutput(inp->inp_socket, sopt, inp, tp));
1889 tcp_ctloutput_get(struct inpcb *inp, struct sockopt *sopt)
1894 MPASS(sopt->sopt_dir == SOPT_GET);
1896 if (sopt->sopt_level != IPPROTO_TCP) {
1898 if (inp->inp_vflag & INP_IPV6PROTO)
1899 error = ip6_ctloutput(inp->inp_socket, sopt);
1901 #if defined(INET6) && defined(INET)
1905 error = ip_ctloutput(inp->inp_socket, sopt);
1910 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1912 return (ECONNRESET);
1914 tp = intotcpcb(inp);
1915 if (((sopt->sopt_name == TCP_FUNCTION_BLK) ||
1916 (sopt->sopt_name == TCP_FUNCTION_ALIAS))) {
1917 struct tcp_function_set fsn;
1919 if (sopt->sopt_name == TCP_FUNCTION_ALIAS) {
1920 memset(&fsn, 0, sizeof(fsn));
1921 find_tcp_function_alias(tp->t_fb, &fsn);
1923 strncpy(fsn.function_set_name,
1924 tp->t_fb->tfb_tcp_block_name,
1925 TCP_FUNCTION_NAME_LEN_MAX);
1926 fsn.function_set_name[TCP_FUNCTION_NAME_LEN_MAX - 1] = '\0';
1928 fsn.pcbcnt = tp->t_fb->tfb_refcnt;
1930 error = sooptcopyout(sopt, &fsn, sizeof fsn);
1934 /* Pass in the INP locked, caller must unlock it. */
1935 return (tp->t_fb->tfb_tcp_ctloutput(inp->inp_socket, sopt, inp, tp));
1939 tcp_ctloutput(struct socket *so, struct sockopt *sopt)
1945 inp = sotoinpcb(so);
1946 KASSERT(inp != NULL, ("tcp_ctloutput: inp == NULL"));
1948 if (sopt->sopt_dir == SOPT_SET)
1949 return (tcp_ctloutput_set(inp, sopt));
1950 else if (sopt->sopt_dir == SOPT_GET)
1951 return (tcp_ctloutput_get(inp, sopt));
1953 panic("%s: sopt_dir $%d", __func__, sopt->sopt_dir);
1957 * If this assert becomes untrue, we need to change the size of the buf
1958 * variable in tcp_default_ctloutput().
1961 CTASSERT(TCP_CA_NAME_MAX <= TCP_LOG_ID_LEN);
1962 CTASSERT(TCP_LOG_REASON_LEN <= TCP_LOG_ID_LEN);
1967 copyin_tls_enable(struct sockopt *sopt, struct tls_enable *tls)
1969 struct tls_enable_v0 tls_v0;
1972 if (sopt->sopt_valsize == sizeof(tls_v0)) {
1973 error = sooptcopyin(sopt, &tls_v0, sizeof(tls_v0),
1977 memset(tls, 0, sizeof(*tls));
1978 tls->cipher_key = tls_v0.cipher_key;
1979 tls->iv = tls_v0.iv;
1980 tls->auth_key = tls_v0.auth_key;
1981 tls->cipher_algorithm = tls_v0.cipher_algorithm;
1982 tls->cipher_key_len = tls_v0.cipher_key_len;
1983 tls->iv_len = tls_v0.iv_len;
1984 tls->auth_algorithm = tls_v0.auth_algorithm;
1985 tls->auth_key_len = tls_v0.auth_key_len;
1986 tls->flags = tls_v0.flags;
1987 tls->tls_vmajor = tls_v0.tls_vmajor;
1988 tls->tls_vminor = tls_v0.tls_vminor;
1992 return (sooptcopyin(sopt, tls, sizeof(*tls), sizeof(*tls)));
1996 extern struct cc_algo newreno_cc_algo;
1999 tcp_congestion(struct socket *so, struct sockopt *sopt, struct inpcb *inp, struct tcpcb *tp)
2001 struct cc_algo *algo;
2003 struct cc_var cc_mem;
2004 char buf[TCP_CA_NAME_MAX];
2009 error = sooptcopyin(sopt, buf, TCP_CA_NAME_MAX - 1, 1);
2012 buf[sopt->sopt_valsize] = '\0';
2014 STAILQ_FOREACH(algo, &cc_list, entries)
2015 if (strncmp(buf, algo->name,
2016 TCP_CA_NAME_MAX) == 0) {
2017 if (algo->flags & CC_MODULE_BEING_REMOVED) {
2018 /* We can't "see" modules being unloaded */
2028 if (algo->cb_init != NULL) {
2029 /* We can now pre-get the memory for the CC */
2030 mem_sz = (*algo->cc_data_sz)();
2035 ptr = malloc(mem_sz, M_CC_MEM, M_WAITOK);
2037 STAILQ_FOREACH(algo, &cc_list, entries)
2038 if (strncmp(buf, algo->name,
2039 TCP_CA_NAME_MAX) == 0)
2043 free(ptr, M_CC_MEM);
2053 * Make sure its all clean and zero and also get
2056 memset(&cc_mem, 0, sizeof(cc_mem));
2057 if (mem_sz != (*algo->cc_data_sz)()) {
2059 free(ptr, M_CC_MEM);
2063 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
2066 free(ptr, M_CC_MEM);
2067 return (ECONNRESET);
2069 tp = intotcpcb(inp);
2071 memset(ptr, 0, mem_sz);
2073 cc_mem.ccvc.tcp = tp;
2075 * We once again hold a write lock over the tcb so it's
2076 * safe to do these things without ordering concerns.
2077 * Note here we init into stack memory.
2079 if (algo->cb_init != NULL)
2080 error = algo->cb_init(&cc_mem, ptr);
2084 * The CC algorithms, when given their memory
2085 * should not fail we could in theory have a
2090 * Touchdown, lets go ahead and move the
2091 * connection to the new CC module by
2092 * copying in the cc_mem after we call
2093 * the old ones cleanup (if any).
2095 if (CC_ALGO(tp)->cb_destroy != NULL)
2096 CC_ALGO(tp)->cb_destroy(tp->ccv);
2097 memcpy(tp->ccv, &cc_mem, sizeof(struct cc_var));
2099 /* Ok now are we where we have gotten past any conn_init? */
2100 if (TCPS_HAVEESTABLISHED(tp->t_state) && (CC_ALGO(tp)->conn_init != NULL)) {
2101 /* Yep run the connection init for the new CC */
2102 CC_ALGO(tp)->conn_init(tp->ccv);
2105 free(ptr, M_CC_MEM);
2111 tcp_default_ctloutput(struct socket *so, struct sockopt *sopt, struct inpcb *inp, struct tcpcb *tp)
2113 int error, opt, optval;
2117 struct tls_enable tls;
2119 char *pbuf, buf[TCP_LOG_ID_LEN];
2121 struct statsblob *sbp;
2125 INP_WLOCK_ASSERT(inp);
2127 switch (sopt->sopt_level) {
2130 MPASS(inp->inp_vflag & INP_IPV6PROTO);
2131 switch (sopt->sopt_name) {
2132 case IPV6_USE_MIN_MTU:
2133 tcp6_use_min_mtu(tp);
2147 * For TCP_CCALGOOPT forward the control to CC module, for both
2148 * SOPT_SET and SOPT_GET.
2150 switch (sopt->sopt_name) {
2153 if (sopt->sopt_valsize > CC_ALGOOPT_LIMIT)
2155 pbuf = malloc(sopt->sopt_valsize, M_TEMP, M_WAITOK | M_ZERO);
2156 error = sooptcopyin(sopt, pbuf, sopt->sopt_valsize,
2157 sopt->sopt_valsize);
2162 INP_WLOCK_RECHECK_CLEANUP(inp, free(pbuf, M_TEMP));
2163 if (CC_ALGO(tp)->ctl_output != NULL)
2164 error = CC_ALGO(tp)->ctl_output(tp->ccv, sopt, pbuf);
2168 if (error == 0 && sopt->sopt_dir == SOPT_GET)
2169 error = sooptcopyout(sopt, pbuf, sopt->sopt_valsize);
2174 switch (sopt->sopt_dir) {
2176 switch (sopt->sopt_name) {
2177 #if defined(IPSEC_SUPPORT) || defined(TCP_SIGNATURE)
2179 if (!TCPMD5_ENABLED()) {
2181 return (ENOPROTOOPT);
2183 error = TCPMD5_PCBCTL(inp, sopt);
2186 goto unlock_and_done;
2193 error = sooptcopyin(sopt, &optval, sizeof optval,
2198 INP_WLOCK_RECHECK(inp);
2199 switch (sopt->sopt_name) {
2210 opt = 0; /* dead code to fool gcc */
2217 tp->t_flags &= ~opt;
2220 if (tp->t_flags & TF_TOE) {
2221 tcp_offload_ctloutput(tp, sopt->sopt_dir,
2230 error = sooptcopyin(sopt, &optval, sizeof optval,
2235 INP_WLOCK_RECHECK(inp);
2237 tp->t_flags |= TF_NOPUSH;
2238 else if (tp->t_flags & TF_NOPUSH) {
2239 tp->t_flags &= ~TF_NOPUSH;
2240 if (TCPS_HAVEESTABLISHED(tp->t_state)) {
2241 struct epoch_tracker et;
2243 NET_EPOCH_ENTER(et);
2244 error = tcp_output_nodrop(tp);
2248 goto unlock_and_done;
2250 case TCP_REMOTE_UDP_ENCAPS_PORT:
2252 error = sooptcopyin(sopt, &optval, sizeof optval,
2256 if ((optval < TCP_TUNNELING_PORT_MIN) ||
2257 (optval > TCP_TUNNELING_PORT_MAX)) {
2258 /* Its got to be in range */
2261 if ((V_tcp_udp_tunneling_port == 0) && (optval != 0)) {
2262 /* You have to have enabled a UDP tunneling port first */
2265 INP_WLOCK_RECHECK(inp);
2266 if (tp->t_state != TCPS_CLOSED) {
2267 /* You can't change after you are connected */
2270 /* Ok we are all good set the port */
2271 tp->t_port = htons(optval);
2273 goto unlock_and_done;
2277 error = sooptcopyin(sopt, &optval, sizeof optval,
2282 INP_WLOCK_RECHECK(inp);
2283 if (optval > 0 && optval <= tp->t_maxseg &&
2284 optval + 40 >= V_tcp_minmss)
2285 tp->t_maxseg = optval;
2288 goto unlock_and_done;
2298 error = sooptcopyin(sopt, &optval, sizeof optval,
2304 sbp = stats_blob_alloc(
2305 V_tcp_perconn_stats_dflt_tpl, 0);
2309 INP_WLOCK_RECHECK(inp);
2310 if ((tp->t_stats != NULL && sbp == NULL) ||
2311 (tp->t_stats == NULL && sbp != NULL)) {
2312 struct statsblob *t = tp->t_stats;
2318 stats_blob_destroy(sbp);
2320 return (EOPNOTSUPP);
2324 case TCP_CONGESTION:
2325 error = tcp_congestion(so, sopt, inp, tp);
2328 case TCP_REUSPORT_LB_NUMA:
2330 error = sooptcopyin(sopt, &optval, sizeof(optval),
2332 INP_WLOCK_RECHECK(inp);
2334 error = in_pcblbgroup_numa(inp, optval);
2339 case TCP_TXTLS_ENABLE:
2341 error = copyin_tls_enable(sopt, &tls);
2344 error = ktls_enable_tx(so, &tls);
2346 case TCP_TXTLS_MODE:
2348 error = sooptcopyin(sopt, &ui, sizeof(ui), sizeof(ui));
2352 INP_WLOCK_RECHECK(inp);
2353 error = ktls_set_tx_mode(so, ui);
2356 case TCP_RXTLS_ENABLE:
2358 error = sooptcopyin(sopt, &tls, sizeof(tls),
2362 error = ktls_enable_rx(so, &tls);
2370 error = sooptcopyin(sopt, &ui, sizeof(ui), sizeof(ui));
2374 if (ui > (UINT_MAX / hz)) {
2380 INP_WLOCK_RECHECK(inp);
2381 switch (sopt->sopt_name) {
2383 tp->t_keepidle = ui;
2385 * XXX: better check current remaining
2386 * timeout and "merge" it with new value.
2388 if ((tp->t_state > TCPS_LISTEN) &&
2389 (tp->t_state <= TCPS_CLOSING))
2390 tcp_timer_activate(tp, TT_KEEP,
2394 tp->t_keepintvl = ui;
2395 if ((tp->t_state == TCPS_FIN_WAIT_2) &&
2396 (TP_MAXIDLE(tp) > 0))
2397 tcp_timer_activate(tp, TT_2MSL,
2401 tp->t_keepinit = ui;
2402 if (tp->t_state == TCPS_SYN_RECEIVED ||
2403 tp->t_state == TCPS_SYN_SENT)
2404 tcp_timer_activate(tp, TT_KEEP,
2408 goto unlock_and_done;
2412 error = sooptcopyin(sopt, &ui, sizeof(ui), sizeof(ui));
2416 INP_WLOCK_RECHECK(inp);
2418 if ((tp->t_state == TCPS_FIN_WAIT_2) &&
2419 (TP_MAXIDLE(tp) > 0))
2420 tcp_timer_activate(tp, TT_2MSL,
2422 goto unlock_and_done;
2428 error = sooptcopyin(sopt, &optval, sizeof optval,
2433 INP_WLOCK_RECHECK(inp);
2435 tcp_pcap_set_sock_max(TCP_PCAP_OUT ?
2436 &(tp->t_outpkts) : &(tp->t_inpkts),
2440 goto unlock_and_done;
2443 case TCP_FASTOPEN: {
2444 struct tcp_fastopen tfo_optval;
2447 if (!V_tcp_fastopen_client_enable &&
2448 !V_tcp_fastopen_server_enable)
2451 error = sooptcopyin(sopt, &tfo_optval,
2452 sizeof(tfo_optval), sizeof(int));
2456 INP_WLOCK_RECHECK(inp);
2457 if ((tp->t_state != TCPS_CLOSED) &&
2458 (tp->t_state != TCPS_LISTEN)) {
2460 goto unlock_and_done;
2462 if (tfo_optval.enable) {
2463 if (tp->t_state == TCPS_LISTEN) {
2464 if (!V_tcp_fastopen_server_enable) {
2466 goto unlock_and_done;
2469 if (tp->t_tfo_pending == NULL)
2471 tcp_fastopen_alloc_counter();
2474 * If a pre-shared key was provided,
2475 * stash it in the client cookie
2476 * field of the tcpcb for use during
2479 if (sopt->sopt_valsize ==
2480 sizeof(tfo_optval)) {
2481 memcpy(tp->t_tfo_cookie.client,
2483 TCP_FASTOPEN_PSK_LEN);
2484 tp->t_tfo_client_cookie_len =
2485 TCP_FASTOPEN_PSK_LEN;
2488 tp->t_flags |= TF_FASTOPEN;
2490 tp->t_flags &= ~TF_FASTOPEN;
2491 goto unlock_and_done;
2497 error = sooptcopyin(sopt, &optval, sizeof optval,
2502 INP_WLOCK_RECHECK(inp);
2503 error = tcp_log_state_change(tp, optval);
2504 goto unlock_and_done;
2513 error = sooptcopyin(sopt, buf, TCP_LOG_ID_LEN - 1, 0);
2516 buf[sopt->sopt_valsize] = '\0';
2517 INP_WLOCK_RECHECK(inp);
2518 error = tcp_log_set_id(tp, buf);
2519 /* tcp_log_set_id() unlocks the INP. */
2526 sooptcopyin(sopt, buf, TCP_LOG_REASON_LEN - 1, 0);
2529 buf[sopt->sopt_valsize] = '\0';
2530 INP_WLOCK_RECHECK(inp);
2531 if (sopt->sopt_name == TCP_LOGDUMP) {
2532 error = tcp_log_dump_tp_logbuf(tp, buf,
2536 tcp_log_dump_tp_bucket_logbufs(tp, buf);
2538 * tcp_log_dump_tp_bucket_logbufs() drops the
2547 error = ENOPROTOOPT;
2553 tp = intotcpcb(inp);
2554 switch (sopt->sopt_name) {
2555 #if defined(IPSEC_SUPPORT) || defined(TCP_SIGNATURE)
2557 if (!TCPMD5_ENABLED()) {
2559 return (ENOPROTOOPT);
2561 error = TCPMD5_PCBCTL(inp, sopt);
2566 optval = tp->t_flags & TF_NODELAY;
2568 error = sooptcopyout(sopt, &optval, sizeof optval);
2571 optval = tp->t_maxseg;
2573 error = sooptcopyout(sopt, &optval, sizeof optval);
2575 case TCP_REMOTE_UDP_ENCAPS_PORT:
2576 optval = ntohs(tp->t_port);
2578 error = sooptcopyout(sopt, &optval, sizeof optval);
2581 optval = tp->t_flags & TF_NOOPT;
2583 error = sooptcopyout(sopt, &optval, sizeof optval);
2586 optval = tp->t_flags & TF_NOPUSH;
2588 error = sooptcopyout(sopt, &optval, sizeof optval);
2591 tcp_fill_info(tp, &ti);
2593 error = sooptcopyout(sopt, &ti, sizeof ti);
2599 TYPEOF_MEMBER(struct statsblob, flags) sbflags = 0;
2602 socklen_t outsbsz = sopt->sopt_valsize;
2603 if (tp->t_stats == NULL)
2605 else if (outsbsz >= tp->t_stats->cursz)
2606 outsbsz = tp->t_stats->cursz;
2607 else if (outsbsz >= sizeof(struct statsblob))
2608 outsbsz = sizeof(struct statsblob);
2615 sbp = sopt->sopt_val;
2616 nheld = atop(round_page(((vm_offset_t)sbp) +
2617 (vm_size_t)outsbsz) - trunc_page((vm_offset_t)sbp));
2618 vm_page_t ma[nheld];
2619 if (vm_fault_quick_hold_pages(
2620 &curproc->p_vmspace->vm_map, (vm_offset_t)sbp,
2621 outsbsz, VM_PROT_READ | VM_PROT_WRITE, ma,
2627 if ((error = copyin_nofault(&(sbp->flags), &sbflags,
2628 SIZEOF_MEMBER(struct statsblob, flags))))
2631 INP_WLOCK_RECHECK(inp);
2632 error = stats_blob_snapshot(&sbp, outsbsz, tp->t_stats,
2633 sbflags | SB_CLONE_USRDSTNOFAULT);
2635 sopt->sopt_valsize = outsbsz;
2637 vm_page_unhold_pages(ma, nheld);
2644 case TCP_CONGESTION:
2645 len = strlcpy(buf, CC_ALGO(tp)->name, TCP_CA_NAME_MAX);
2647 error = sooptcopyout(sopt, buf, len + 1);
2653 switch (sopt->sopt_name) {
2655 ui = TP_KEEPIDLE(tp) / hz;
2658 ui = TP_KEEPINTVL(tp) / hz;
2661 ui = TP_KEEPINIT(tp) / hz;
2664 ui = TP_KEEPCNT(tp);
2668 error = sooptcopyout(sopt, &ui, sizeof(ui));
2673 optval = tcp_pcap_get_sock_max(TCP_PCAP_OUT ?
2674 &(tp->t_outpkts) : &(tp->t_inpkts));
2676 error = sooptcopyout(sopt, &optval, sizeof optval);
2680 optval = tp->t_flags & TF_FASTOPEN;
2682 error = sooptcopyout(sopt, &optval, sizeof optval);
2686 optval = tp->t_logstate;
2688 error = sooptcopyout(sopt, &optval, sizeof(optval));
2691 /* tcp_log_getlogbuf() does INP_WUNLOCK(inp) */
2692 error = tcp_log_getlogbuf(sopt, tp);
2695 len = tcp_log_get_id(tp, buf);
2697 error = sooptcopyout(sopt, buf, len + 1);
2706 case TCP_TXTLS_MODE:
2707 error = ktls_get_tx_mode(so, &optval);
2710 error = sooptcopyout(sopt, &optval,
2713 case TCP_RXTLS_MODE:
2714 error = ktls_get_rx_mode(so, &optval);
2717 error = sooptcopyout(sopt, &optval,
2722 optval = tp->t_flags & TF_LRD;
2724 error = sooptcopyout(sopt, &optval, sizeof optval);
2728 error = ENOPROTOOPT;
2735 #undef INP_WLOCK_RECHECK
2736 #undef INP_WLOCK_RECHECK_CLEANUP
2739 * Initiate (or continue) disconnect.
2740 * If embryonic state, just send reset (once).
2741 * If in ``let data drain'' option and linger null, just drop.
2742 * Otherwise (hard), mark socket disconnecting and drop
2743 * current input data; switch states based on user close, and
2744 * send segment to peer (with FIN).
2747 tcp_disconnect(struct tcpcb *tp)
2749 struct inpcb *inp = tp->t_inpcb;
2750 struct socket *so = inp->inp_socket;
2753 INP_WLOCK_ASSERT(inp);
2756 * Neither tcp_close() nor tcp_drop() should return NULL, as the
2757 * socket is still open.
2759 if (tp->t_state < TCPS_ESTABLISHED &&
2760 !(tp->t_state > TCPS_LISTEN && IS_FASTOPEN(tp->t_flags))) {
2763 ("tcp_disconnect: tcp_close() returned NULL"));
2764 } else if ((so->so_options & SO_LINGER) && so->so_linger == 0) {
2765 tp = tcp_drop(tp, 0);
2767 ("tcp_disconnect: tcp_drop() returned NULL"));
2769 soisdisconnecting(so);
2770 sbflush(&so->so_rcv);
2772 if (!(inp->inp_flags & INP_DROPPED))
2773 /* Ignore stack's drop request, we already at it. */
2774 (void)tcp_output_nodrop(tp);
2779 * User issued close, and wish to trail through shutdown states:
2780 * if never received SYN, just forget it. If got a SYN from peer,
2781 * but haven't sent FIN, then go to FIN_WAIT_1 state to send peer a FIN.
2782 * If already got a FIN from peer, then almost done; go to LAST_ACK
2783 * state. In all other cases, have already sent FIN to peer (e.g.
2784 * after PRU_SHUTDOWN), and just have to play tedious game waiting
2785 * for peer to send FIN or not respond to keep-alives, etc.
2786 * We can let the user exit from the close as soon as the FIN is acked.
2789 tcp_usrclosed(struct tcpcb *tp)
2793 INP_WLOCK_ASSERT(tp->t_inpcb);
2795 switch (tp->t_state) {
2798 tcp_offload_listen_stop(tp);
2800 tcp_state_change(tp, TCPS_CLOSED);
2805 * tcp_close() should never return NULL here as the socket is
2809 ("tcp_usrclosed: tcp_close() returned NULL"));
2813 case TCPS_SYN_RECEIVED:
2814 tp->t_flags |= TF_NEEDFIN;
2817 case TCPS_ESTABLISHED:
2818 tcp_state_change(tp, TCPS_FIN_WAIT_1);
2821 case TCPS_CLOSE_WAIT:
2822 tcp_state_change(tp, TCPS_LAST_ACK);
2825 if (tp->t_state >= TCPS_FIN_WAIT_2) {
2826 soisdisconnected(tp->t_inpcb->inp_socket);
2827 /* Prevent the connection hanging in FIN_WAIT_2 forever. */
2828 if (tp->t_state == TCPS_FIN_WAIT_2) {
2831 timeout = (tcp_fast_finwait2_recycle) ?
2832 tcp_finwait2_timeout : TP_MAXIDLE(tp);
2833 tcp_timer_activate(tp, TT_2MSL, timeout);
2840 db_print_indent(int indent)
2844 for (i = 0; i < indent; i++)
2849 db_print_tstate(int t_state)
2854 db_printf("TCPS_CLOSED");
2858 db_printf("TCPS_LISTEN");
2862 db_printf("TCPS_SYN_SENT");
2865 case TCPS_SYN_RECEIVED:
2866 db_printf("TCPS_SYN_RECEIVED");
2869 case TCPS_ESTABLISHED:
2870 db_printf("TCPS_ESTABLISHED");
2873 case TCPS_CLOSE_WAIT:
2874 db_printf("TCPS_CLOSE_WAIT");
2877 case TCPS_FIN_WAIT_1:
2878 db_printf("TCPS_FIN_WAIT_1");
2882 db_printf("TCPS_CLOSING");
2886 db_printf("TCPS_LAST_ACK");
2889 case TCPS_FIN_WAIT_2:
2890 db_printf("TCPS_FIN_WAIT_2");
2893 case TCPS_TIME_WAIT:
2894 db_printf("TCPS_TIME_WAIT");
2898 db_printf("unknown");
2904 db_print_tflags(u_int t_flags)
2909 if (t_flags & TF_ACKNOW) {
2910 db_printf("%sTF_ACKNOW", comma ? ", " : "");
2913 if (t_flags & TF_DELACK) {
2914 db_printf("%sTF_DELACK", comma ? ", " : "");
2917 if (t_flags & TF_NODELAY) {
2918 db_printf("%sTF_NODELAY", comma ? ", " : "");
2921 if (t_flags & TF_NOOPT) {
2922 db_printf("%sTF_NOOPT", comma ? ", " : "");
2925 if (t_flags & TF_SENTFIN) {
2926 db_printf("%sTF_SENTFIN", comma ? ", " : "");
2929 if (t_flags & TF_REQ_SCALE) {
2930 db_printf("%sTF_REQ_SCALE", comma ? ", " : "");
2933 if (t_flags & TF_RCVD_SCALE) {
2934 db_printf("%sTF_RECVD_SCALE", comma ? ", " : "");
2937 if (t_flags & TF_REQ_TSTMP) {
2938 db_printf("%sTF_REQ_TSTMP", comma ? ", " : "");
2941 if (t_flags & TF_RCVD_TSTMP) {
2942 db_printf("%sTF_RCVD_TSTMP", comma ? ", " : "");
2945 if (t_flags & TF_SACK_PERMIT) {
2946 db_printf("%sTF_SACK_PERMIT", comma ? ", " : "");
2949 if (t_flags & TF_NEEDSYN) {
2950 db_printf("%sTF_NEEDSYN", comma ? ", " : "");
2953 if (t_flags & TF_NEEDFIN) {
2954 db_printf("%sTF_NEEDFIN", comma ? ", " : "");
2957 if (t_flags & TF_NOPUSH) {
2958 db_printf("%sTF_NOPUSH", comma ? ", " : "");
2961 if (t_flags & TF_MORETOCOME) {
2962 db_printf("%sTF_MORETOCOME", comma ? ", " : "");
2965 if (t_flags & TF_LQ_OVERFLOW) {
2966 db_printf("%sTF_LQ_OVERFLOW", comma ? ", " : "");
2969 if (t_flags & TF_LASTIDLE) {
2970 db_printf("%sTF_LASTIDLE", comma ? ", " : "");
2973 if (t_flags & TF_RXWIN0SENT) {
2974 db_printf("%sTF_RXWIN0SENT", comma ? ", " : "");
2977 if (t_flags & TF_FASTRECOVERY) {
2978 db_printf("%sTF_FASTRECOVERY", comma ? ", " : "");
2981 if (t_flags & TF_CONGRECOVERY) {
2982 db_printf("%sTF_CONGRECOVERY", comma ? ", " : "");
2985 if (t_flags & TF_WASFRECOVERY) {
2986 db_printf("%sTF_WASFRECOVERY", comma ? ", " : "");
2989 if (t_flags & TF_SIGNATURE) {
2990 db_printf("%sTF_SIGNATURE", comma ? ", " : "");
2993 if (t_flags & TF_FORCEDATA) {
2994 db_printf("%sTF_FORCEDATA", comma ? ", " : "");
2997 if (t_flags & TF_TSO) {
2998 db_printf("%sTF_TSO", comma ? ", " : "");
3001 if (t_flags & TF_FASTOPEN) {
3002 db_printf("%sTF_FASTOPEN", comma ? ", " : "");
3008 db_print_tflags2(u_int t_flags2)
3013 if (t_flags2 & TF2_ECN_PERMIT) {
3014 db_printf("%sTF2_ECN_PERMIT", comma ? ", " : "");
3020 db_print_toobflags(char t_oobflags)
3025 if (t_oobflags & TCPOOB_HAVEDATA) {
3026 db_printf("%sTCPOOB_HAVEDATA", comma ? ", " : "");
3029 if (t_oobflags & TCPOOB_HADDATA) {
3030 db_printf("%sTCPOOB_HADDATA", comma ? ", " : "");
3036 db_print_tcpcb(struct tcpcb *tp, const char *name, int indent)
3039 db_print_indent(indent);
3040 db_printf("%s at %p\n", name, tp);
3044 db_print_indent(indent);
3045 db_printf("t_segq first: %p t_segqlen: %d t_dupacks: %d\n",
3046 TAILQ_FIRST(&tp->t_segq), tp->t_segqlen, tp->t_dupacks);
3048 db_print_indent(indent);
3049 db_printf("tt_rexmt: %p tt_persist: %p tt_keep: %p\n",
3050 &tp->t_timers->tt_rexmt, &tp->t_timers->tt_persist, &tp->t_timers->tt_keep);
3052 db_print_indent(indent);
3053 db_printf("tt_2msl: %p tt_delack: %p t_inpcb: %p\n", &tp->t_timers->tt_2msl,
3054 &tp->t_timers->tt_delack, tp->t_inpcb);
3056 db_print_indent(indent);
3057 db_printf("t_state: %d (", tp->t_state);
3058 db_print_tstate(tp->t_state);
3061 db_print_indent(indent);
3062 db_printf("t_flags: 0x%x (", tp->t_flags);
3063 db_print_tflags(tp->t_flags);
3066 db_print_indent(indent);
3067 db_printf("t_flags2: 0x%x (", tp->t_flags2);
3068 db_print_tflags2(tp->t_flags2);
3071 db_print_indent(indent);
3072 db_printf("snd_una: 0x%08x snd_max: 0x%08x snd_nxt: x0%08x\n",
3073 tp->snd_una, tp->snd_max, tp->snd_nxt);
3075 db_print_indent(indent);
3076 db_printf("snd_up: 0x%08x snd_wl1: 0x%08x snd_wl2: 0x%08x\n",
3077 tp->snd_up, tp->snd_wl1, tp->snd_wl2);
3079 db_print_indent(indent);
3080 db_printf("iss: 0x%08x irs: 0x%08x rcv_nxt: 0x%08x\n",
3081 tp->iss, tp->irs, tp->rcv_nxt);
3083 db_print_indent(indent);
3084 db_printf("rcv_adv: 0x%08x rcv_wnd: %u rcv_up: 0x%08x\n",
3085 tp->rcv_adv, tp->rcv_wnd, tp->rcv_up);
3087 db_print_indent(indent);
3088 db_printf("snd_wnd: %u snd_cwnd: %u\n",
3089 tp->snd_wnd, tp->snd_cwnd);
3091 db_print_indent(indent);
3092 db_printf("snd_ssthresh: %u snd_recover: "
3093 "0x%08x\n", tp->snd_ssthresh, tp->snd_recover);
3095 db_print_indent(indent);
3096 db_printf("t_rcvtime: %u t_startime: %u\n",
3097 tp->t_rcvtime, tp->t_starttime);
3099 db_print_indent(indent);
3100 db_printf("t_rttime: %u t_rtsq: 0x%08x\n",
3101 tp->t_rtttime, tp->t_rtseq);
3103 db_print_indent(indent);
3104 db_printf("t_rxtcur: %d t_maxseg: %u t_srtt: %d\n",
3105 tp->t_rxtcur, tp->t_maxseg, tp->t_srtt);
3107 db_print_indent(indent);
3108 db_printf("t_rttvar: %d t_rxtshift: %d t_rttmin: %u "
3109 "t_rttbest: %u\n", tp->t_rttvar, tp->t_rxtshift, tp->t_rttmin,
3112 db_print_indent(indent);
3113 db_printf("t_rttupdated: %lu max_sndwnd: %u t_softerror: %d\n",
3114 tp->t_rttupdated, tp->max_sndwnd, tp->t_softerror);
3116 db_print_indent(indent);
3117 db_printf("t_oobflags: 0x%x (", tp->t_oobflags);
3118 db_print_toobflags(tp->t_oobflags);
3119 db_printf(") t_iobc: 0x%02x\n", tp->t_iobc);
3121 db_print_indent(indent);
3122 db_printf("snd_scale: %u rcv_scale: %u request_r_scale: %u\n",
3123 tp->snd_scale, tp->rcv_scale, tp->request_r_scale);
3125 db_print_indent(indent);
3126 db_printf("ts_recent: %u ts_recent_age: %u\n",
3127 tp->ts_recent, tp->ts_recent_age);
3129 db_print_indent(indent);
3130 db_printf("ts_offset: %u last_ack_sent: 0x%08x snd_cwnd_prev: "
3131 "%u\n", tp->ts_offset, tp->last_ack_sent, tp->snd_cwnd_prev);
3133 db_print_indent(indent);
3134 db_printf("snd_ssthresh_prev: %u snd_recover_prev: 0x%08x "
3135 "t_badrxtwin: %u\n", tp->snd_ssthresh_prev,
3136 tp->snd_recover_prev, tp->t_badrxtwin);
3138 db_print_indent(indent);
3139 db_printf("snd_numholes: %d snd_holes first: %p\n",
3140 tp->snd_numholes, TAILQ_FIRST(&tp->snd_holes));
3142 db_print_indent(indent);
3143 db_printf("snd_fack: 0x%08x rcv_numsacks: %d\n",
3144 tp->snd_fack, tp->rcv_numsacks);
3146 /* Skip sackblks, sackhint. */
3148 db_print_indent(indent);
3149 db_printf("t_rttlow: %d rfbuf_ts: %u rfbuf_cnt: %d\n",
3150 tp->t_rttlow, tp->rfbuf_ts, tp->rfbuf_cnt);
3153 DB_SHOW_COMMAND(tcpcb, db_show_tcpcb)
3158 db_printf("usage: show tcpcb <addr>\n");
3161 tp = (struct tcpcb *)addr;
3163 db_print_tcpcb(tp, "tcpcb", 0);