2 * Copyright (c) 1982, 1986, 1988, 1993
3 * The Regents of the University of California.
4 * Copyright (c) 2006-2007 Robert N. M. Watson
5 * Copyright (c) 2010-2011 Juniper Networks, Inc.
8 * Portions of this software were developed by Robert N. M. Watson under
9 * contract to Juniper Networks, Inc.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * From: @(#)tcp_usrreq.c 8.2 (Berkeley) 1/3/94
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
43 #include "opt_inet6.h"
44 #include "opt_ipsec.h"
45 #include "opt_tcpdebug.h"
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/limits.h>
50 #include <sys/malloc.h>
51 #include <sys/refcount.h>
52 #include <sys/kernel.h>
53 #include <sys/sysctl.h>
56 #include <sys/domain.h>
58 #include <sys/socket.h>
59 #include <sys/socketvar.h>
60 #include <sys/protosw.h>
63 #include <sys/syslog.h>
70 #include <net/if_var.h>
71 #include <net/route.h>
74 #include <netinet/in.h>
75 #include <netinet/in_kdtrace.h>
76 #include <netinet/in_pcb.h>
77 #include <netinet/in_systm.h>
78 #include <netinet/in_var.h>
79 #include <netinet/ip_var.h>
81 #include <netinet/ip6.h>
82 #include <netinet6/in6_pcb.h>
83 #include <netinet6/ip6_var.h>
84 #include <netinet6/scope6_var.h>
87 #include <netinet/tcp_fastopen.h>
89 #include <netinet/tcp.h>
90 #include <netinet/tcp_fsm.h>
91 #include <netinet/tcp_seq.h>
92 #include <netinet/tcp_timer.h>
93 #include <netinet/tcp_var.h>
94 #include <netinet/tcpip.h>
95 #include <netinet/cc/cc.h>
97 #include <netinet/tcp_pcap.h>
100 #include <netinet/tcp_debug.h>
103 #include <netinet/tcp_offload.h>
105 #include <netipsec/ipsec_support.h>
108 * TCP protocol interface to socket abstraction.
110 static int tcp_attach(struct socket *);
112 static int tcp_connect(struct tcpcb *, struct sockaddr *,
116 static int tcp6_connect(struct tcpcb *, struct sockaddr *,
119 static void tcp_disconnect(struct tcpcb *);
120 static void tcp_usrclosed(struct tcpcb *);
121 static void tcp_fill_info(struct tcpcb *, struct tcp_info *);
124 #define TCPDEBUG0 int ostate = 0
125 #define TCPDEBUG1() ostate = tp ? tp->t_state : 0
126 #define TCPDEBUG2(req) if (tp && (so->so_options & SO_DEBUG)) \
127 tcp_trace(TA_USER, ostate, tp, 0, 0, req)
131 #define TCPDEBUG2(req)
135 * TCP attaches to socket via pru_attach(), reserving space,
136 * and an internet control block.
139 tcp_usr_attach(struct socket *so, int proto, struct thread *td)
142 struct tcpcb *tp = NULL;
147 KASSERT(inp == NULL, ("tcp_usr_attach: inp != NULL"));
150 error = tcp_attach(so);
154 if ((so->so_options & SO_LINGER) && so->so_linger == 0)
155 so->so_linger = TCP_LINGERTIME;
160 TCPDEBUG2(PRU_ATTACH);
161 TCP_PROBE2(debug__user, tp, PRU_ATTACH);
166 * tcp_detach is called when the socket layer loses its final reference
167 * to the socket, be it a file descriptor reference, a reference from TCP,
168 * etc. At this point, there is only one case in which we will keep around
169 * inpcb state: time wait.
171 * This function can probably be re-absorbed back into tcp_usr_detach() now
172 * that there is a single detach path.
175 tcp_detach(struct socket *so, struct inpcb *inp)
179 INP_INFO_LOCK_ASSERT(&V_tcbinfo);
180 INP_WLOCK_ASSERT(inp);
182 KASSERT(so->so_pcb == inp, ("tcp_detach: so_pcb != inp"));
183 KASSERT(inp->inp_socket == so, ("tcp_detach: inp_socket != so"));
187 if (inp->inp_flags & INP_TIMEWAIT) {
189 * There are two cases to handle: one in which the time wait
190 * state is being discarded (INP_DROPPED), and one in which
191 * this connection will remain in timewait. In the former,
192 * it is time to discard all state (except tcptw, which has
193 * already been discarded by the timewait close code, which
194 * should be further up the call stack somewhere). In the
195 * latter case, we detach from the socket, but leave the pcb
196 * present until timewait ends.
198 * XXXRW: Would it be cleaner to free the tcptw here?
200 * Astute question indeed, from twtcp perspective there are
201 * three cases to consider:
203 * #1 tcp_detach is called at tcptw creation time by
204 * tcp_twstart, then do not discard the newly created tcptw
205 * and leave inpcb present until timewait ends
206 * #2 tcp_detach is called at timewait end (or reuse) by
207 * tcp_twclose, then the tcptw has already been discarded
208 * (or reused) and inpcb is freed here
209 * #3 tcp_detach is called() after timewait ends (or reuse)
210 * (e.g. by soclose), then tcptw has already been discarded
211 * (or reused) and inpcb is freed here
213 * In all three cases the tcptw should not be freed here.
215 if (inp->inp_flags & INP_DROPPED) {
217 if (__predict_true(tp == NULL)) {
221 * This case should not happen as in TIMEWAIT
222 * state the inp should not be destroyed before
223 * its tcptw. If INVARIANTS is defined, panic.
226 panic("%s: Panic before an inp double-free: "
227 "INP_TIMEWAIT && INP_DROPPED && tp != NULL"
230 log(LOG_ERR, "%s: Avoid an inp double-free: "
231 "INP_TIMEWAIT && INP_DROPPED && tp != NULL"
242 * If the connection is not in timewait, we consider two
243 * two conditions: one in which no further processing is
244 * necessary (dropped || embryonic), and one in which TCP is
245 * not yet done, but no longer requires the socket, so the
246 * pcb will persist for the time being.
248 * XXXRW: Does the second case still occur?
250 if (inp->inp_flags & INP_DROPPED ||
251 tp->t_state < TCPS_SYN_SENT) {
263 * pru_detach() detaches the TCP protocol from the socket.
264 * If the protocol state is non-embryonic, then can't
265 * do this directly: have to initiate a pru_disconnect(),
266 * which may finish later; embryonic TCB's can just
270 tcp_usr_detach(struct socket *so)
276 KASSERT(inp != NULL, ("tcp_usr_detach: inp == NULL"));
277 if (!INP_INFO_WLOCKED(&V_tcbinfo)) {
278 INP_INFO_RLOCK(&V_tcbinfo);
282 KASSERT(inp->inp_socket != NULL,
283 ("tcp_usr_detach: inp_socket == NULL"));
286 INP_INFO_RUNLOCK(&V_tcbinfo);
291 * Give the socket an address.
294 tcp_usr_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
298 struct tcpcb *tp = NULL;
299 struct sockaddr_in *sinp;
301 sinp = (struct sockaddr_in *)nam;
302 if (nam->sa_len != sizeof (*sinp))
305 * Must check for multicast addresses and disallow binding
308 if (sinp->sin_family == AF_INET &&
309 IN_MULTICAST(ntohl(sinp->sin_addr.s_addr)))
310 return (EAFNOSUPPORT);
314 KASSERT(inp != NULL, ("tcp_usr_bind: inp == NULL"));
316 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
322 INP_HASH_WLOCK(&V_tcbinfo);
323 error = in_pcbbind(inp, nam, td->td_ucred);
324 INP_HASH_WUNLOCK(&V_tcbinfo);
327 TCP_PROBE2(debug__user, tp, PRU_BIND);
336 tcp6_usr_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
340 struct tcpcb *tp = NULL;
341 struct sockaddr_in6 *sin6p;
343 sin6p = (struct sockaddr_in6 *)nam;
344 if (nam->sa_len != sizeof (*sin6p))
347 * Must check for multicast addresses and disallow binding
350 if (sin6p->sin6_family == AF_INET6 &&
351 IN6_IS_ADDR_MULTICAST(&sin6p->sin6_addr))
352 return (EAFNOSUPPORT);
356 KASSERT(inp != NULL, ("tcp6_usr_bind: inp == NULL"));
358 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
364 INP_HASH_WLOCK(&V_tcbinfo);
365 inp->inp_vflag &= ~INP_IPV4;
366 inp->inp_vflag |= INP_IPV6;
368 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) == 0) {
369 if (IN6_IS_ADDR_UNSPECIFIED(&sin6p->sin6_addr))
370 inp->inp_vflag |= INP_IPV4;
371 else if (IN6_IS_ADDR_V4MAPPED(&sin6p->sin6_addr)) {
372 struct sockaddr_in sin;
374 in6_sin6_2_sin(&sin, sin6p);
375 inp->inp_vflag |= INP_IPV4;
376 inp->inp_vflag &= ~INP_IPV6;
377 error = in_pcbbind(inp, (struct sockaddr *)&sin,
379 INP_HASH_WUNLOCK(&V_tcbinfo);
384 error = in6_pcbbind(inp, nam, td->td_ucred);
385 INP_HASH_WUNLOCK(&V_tcbinfo);
388 TCP_PROBE2(debug__user, tp, PRU_BIND);
396 * Prepare to accept connections.
399 tcp_usr_listen(struct socket *so, int backlog, struct thread *td)
403 struct tcpcb *tp = NULL;
407 KASSERT(inp != NULL, ("tcp_usr_listen: inp == NULL"));
409 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
416 error = solisten_proto_check(so);
417 INP_HASH_WLOCK(&V_tcbinfo);
418 if (error == 0 && inp->inp_lport == 0)
419 error = in_pcbbind(inp, (struct sockaddr *)0, td->td_ucred);
420 INP_HASH_WUNLOCK(&V_tcbinfo);
422 tcp_state_change(tp, TCPS_LISTEN);
423 solisten_proto(so, backlog);
425 if ((so->so_options & SO_NO_OFFLOAD) == 0)
426 tcp_offload_listen_start(tp);
432 if (tp->t_flags & TF_FASTOPEN)
433 tp->t_tfo_pending = tcp_fastopen_alloc_counter();
436 TCPDEBUG2(PRU_LISTEN);
437 TCP_PROBE2(debug__user, tp, PRU_LISTEN);
445 tcp6_usr_listen(struct socket *so, int backlog, struct thread *td)
449 struct tcpcb *tp = NULL;
453 KASSERT(inp != NULL, ("tcp6_usr_listen: inp == NULL"));
455 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
462 error = solisten_proto_check(so);
463 INP_HASH_WLOCK(&V_tcbinfo);
464 if (error == 0 && inp->inp_lport == 0) {
465 inp->inp_vflag &= ~INP_IPV4;
466 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) == 0)
467 inp->inp_vflag |= INP_IPV4;
468 error = in6_pcbbind(inp, (struct sockaddr *)0, td->td_ucred);
470 INP_HASH_WUNLOCK(&V_tcbinfo);
472 tcp_state_change(tp, TCPS_LISTEN);
473 solisten_proto(so, backlog);
475 if ((so->so_options & SO_NO_OFFLOAD) == 0)
476 tcp_offload_listen_start(tp);
482 if (tp->t_flags & TF_FASTOPEN)
483 tp->t_tfo_pending = tcp_fastopen_alloc_counter();
486 TCPDEBUG2(PRU_LISTEN);
487 TCP_PROBE2(debug__user, tp, PRU_LISTEN);
495 * Initiate connection to peer.
496 * Create a template for use in transmissions on this connection.
497 * Enter SYN_SENT state, and mark socket as connecting.
498 * Start keep-alive timer, and seed output sequence space.
499 * Send initial segment on connection.
502 tcp_usr_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
506 struct tcpcb *tp = NULL;
507 struct sockaddr_in *sinp;
509 sinp = (struct sockaddr_in *)nam;
510 if (nam->sa_len != sizeof (*sinp))
513 * Must disallow TCP ``connections'' to multicast addresses.
515 if (sinp->sin_family == AF_INET
516 && IN_MULTICAST(ntohl(sinp->sin_addr.s_addr)))
517 return (EAFNOSUPPORT);
518 if ((error = prison_remote_ip4(td->td_ucred, &sinp->sin_addr)) != 0)
523 KASSERT(inp != NULL, ("tcp_usr_connect: inp == NULL"));
525 if (inp->inp_flags & INP_TIMEWAIT) {
529 if (inp->inp_flags & INP_DROPPED) {
530 error = ECONNREFUSED;
535 if ((error = tcp_connect(tp, nam, td)) != 0)
538 if (registered_toedevs > 0 &&
539 (so->so_options & SO_NO_OFFLOAD) == 0 &&
540 (error = tcp_offload_connect(so, nam)) == 0)
543 tcp_timer_activate(tp, TT_KEEP, TP_KEEPINIT(tp));
544 error = tp->t_fb->tfb_tcp_output(tp);
546 TCPDEBUG2(PRU_CONNECT);
547 TCP_PROBE2(debug__user, tp, PRU_CONNECT);
555 tcp6_usr_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
559 struct tcpcb *tp = NULL;
560 struct sockaddr_in6 *sin6p;
564 sin6p = (struct sockaddr_in6 *)nam;
565 if (nam->sa_len != sizeof (*sin6p))
568 * Must disallow TCP ``connections'' to multicast addresses.
570 if (sin6p->sin6_family == AF_INET6
571 && IN6_IS_ADDR_MULTICAST(&sin6p->sin6_addr))
572 return (EAFNOSUPPORT);
575 KASSERT(inp != NULL, ("tcp6_usr_connect: inp == NULL"));
577 if (inp->inp_flags & INP_TIMEWAIT) {
581 if (inp->inp_flags & INP_DROPPED) {
582 error = ECONNREFUSED;
589 * XXXRW: Some confusion: V4/V6 flags relate to binding, and
590 * therefore probably require the hash lock, which isn't held here.
591 * Is this a significant problem?
593 if (IN6_IS_ADDR_V4MAPPED(&sin6p->sin6_addr)) {
594 struct sockaddr_in sin;
596 if ((inp->inp_flags & IN6P_IPV6_V6ONLY) != 0) {
601 in6_sin6_2_sin(&sin, sin6p);
602 inp->inp_vflag |= INP_IPV4;
603 inp->inp_vflag &= ~INP_IPV6;
604 if ((error = prison_remote_ip4(td->td_ucred,
605 &sin.sin_addr)) != 0)
607 if ((error = tcp_connect(tp, (struct sockaddr *)&sin, td)) != 0)
610 if (registered_toedevs > 0 &&
611 (so->so_options & SO_NO_OFFLOAD) == 0 &&
612 (error = tcp_offload_connect(so, nam)) == 0)
615 error = tp->t_fb->tfb_tcp_output(tp);
619 inp->inp_vflag &= ~INP_IPV4;
620 inp->inp_vflag |= INP_IPV6;
621 inp->inp_inc.inc_flags |= INC_ISIPV6;
622 if ((error = prison_remote_ip6(td->td_ucred, &sin6p->sin6_addr)) != 0)
624 if ((error = tcp6_connect(tp, nam, td)) != 0)
627 if (registered_toedevs > 0 &&
628 (so->so_options & SO_NO_OFFLOAD) == 0 &&
629 (error = tcp_offload_connect(so, nam)) == 0)
632 tcp_timer_activate(tp, TT_KEEP, TP_KEEPINIT(tp));
633 error = tp->t_fb->tfb_tcp_output(tp);
636 TCPDEBUG2(PRU_CONNECT);
637 TCP_PROBE2(debug__user, tp, PRU_CONNECT);
644 * Initiate disconnect from peer.
645 * If connection never passed embryonic stage, just drop;
646 * else if don't need to let data drain, then can just drop anyways,
647 * else have to begin TCP shutdown process: mark socket disconnecting,
648 * drain unread data, state switch to reflect user close, and
649 * send segment (e.g. FIN) to peer. Socket will be really disconnected
650 * when peer sends FIN and acks ours.
652 * SHOULD IMPLEMENT LATER PRU_CONNECT VIA REALLOC TCPCB.
655 tcp_usr_disconnect(struct socket *so)
658 struct tcpcb *tp = NULL;
662 INP_INFO_RLOCK(&V_tcbinfo);
664 KASSERT(inp != NULL, ("tcp_usr_disconnect: inp == NULL"));
666 if (inp->inp_flags & INP_TIMEWAIT)
668 if (inp->inp_flags & INP_DROPPED) {
676 TCPDEBUG2(PRU_DISCONNECT);
677 TCP_PROBE2(debug__user, tp, PRU_DISCONNECT);
679 INP_INFO_RUNLOCK(&V_tcbinfo);
685 * Accept a connection. Essentially all the work is done at higher levels;
686 * just return the address of the peer, storing through addr.
689 tcp_usr_accept(struct socket *so, struct sockaddr **nam)
692 struct inpcb *inp = NULL;
693 struct tcpcb *tp = NULL;
698 if (so->so_state & SS_ISDISCONNECTED)
699 return (ECONNABORTED);
702 KASSERT(inp != NULL, ("tcp_usr_accept: inp == NULL"));
704 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
705 error = ECONNABORTED;
712 * We inline in_getpeeraddr and COMMON_END here, so that we can
713 * copy the data of interest and defer the malloc until after we
716 port = inp->inp_fport;
717 addr = inp->inp_faddr;
720 TCPDEBUG2(PRU_ACCEPT);
721 TCP_PROBE2(debug__user, tp, PRU_ACCEPT);
724 *nam = in_sockaddr(port, &addr);
731 tcp6_usr_accept(struct socket *so, struct sockaddr **nam)
733 struct inpcb *inp = NULL;
735 struct tcpcb *tp = NULL;
737 struct in6_addr addr6;
742 if (so->so_state & SS_ISDISCONNECTED)
743 return (ECONNABORTED);
746 KASSERT(inp != NULL, ("tcp6_usr_accept: inp == NULL"));
747 INP_INFO_RLOCK(&V_tcbinfo);
749 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
750 error = ECONNABORTED;
757 * We inline in6_mapped_peeraddr and COMMON_END here, so that we can
758 * copy the data of interest and defer the malloc until after we
761 if (inp->inp_vflag & INP_IPV4) {
763 port = inp->inp_fport;
764 addr = inp->inp_faddr;
766 port = inp->inp_fport;
767 addr6 = inp->in6p_faddr;
771 TCPDEBUG2(PRU_ACCEPT);
772 TCP_PROBE2(debug__user, tp, PRU_ACCEPT);
774 INP_INFO_RUNLOCK(&V_tcbinfo);
777 *nam = in6_v4mapsin6_sockaddr(port, &addr);
779 *nam = in6_sockaddr(port, &addr6);
786 * Mark the connection as being incapable of further output.
789 tcp_usr_shutdown(struct socket *so)
793 struct tcpcb *tp = NULL;
796 INP_INFO_RLOCK(&V_tcbinfo);
798 KASSERT(inp != NULL, ("inp == NULL"));
800 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
808 if (!(inp->inp_flags & INP_DROPPED))
809 error = tp->t_fb->tfb_tcp_output(tp);
812 TCPDEBUG2(PRU_SHUTDOWN);
813 TCP_PROBE2(debug__user, tp, PRU_SHUTDOWN);
815 INP_INFO_RUNLOCK(&V_tcbinfo);
821 * After a receive, possibly send window update to peer.
824 tcp_usr_rcvd(struct socket *so, int flags)
827 struct tcpcb *tp = NULL;
832 KASSERT(inp != NULL, ("tcp_usr_rcvd: inp == NULL"));
834 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
842 * For passively-created TFO connections, don't attempt a window
843 * update while still in SYN_RECEIVED as this may trigger an early
844 * SYN|ACK. It is preferable to have the SYN|ACK be sent along with
845 * application response data, or failing that, when the DELACK timer
848 if ((tp->t_flags & TF_FASTOPEN) &&
849 (tp->t_state == TCPS_SYN_RECEIVED))
853 if (tp->t_flags & TF_TOE)
854 tcp_offload_rcvd(tp);
857 tp->t_fb->tfb_tcp_output(tp);
861 TCP_PROBE2(debug__user, tp, PRU_RCVD);
867 * Do a send by putting data in output queue and updating urgent
868 * marker if URG set. Possibly send more data. Unlike the other
869 * pru_*() routines, the mbuf chains are our responsibility. We
870 * must either enqueue them or free them. The other pru_* routines
871 * generally are caller-frees.
874 tcp_usr_send(struct socket *so, int flags, struct mbuf *m,
875 struct sockaddr *nam, struct mbuf *control, struct thread *td)
879 struct tcpcb *tp = NULL;
886 * We require the pcbinfo lock if we will close the socket as part of
889 if (flags & PRUS_EOF)
890 INP_INFO_RLOCK(&V_tcbinfo);
892 KASSERT(inp != NULL, ("tcp_usr_send: inp == NULL"));
894 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
898 * In case of PRUS_NOTREADY, tcp_usr_ready() is responsible
899 * for freeing memory.
901 if (m && (flags & PRUS_NOTREADY) == 0)
907 isipv6 = nam && nam->sa_family == AF_INET6;
912 /* TCP doesn't do control messages (rights, creds, etc) */
913 if (control->m_len) {
920 m_freem(control); /* empty control, just free it */
922 if (!(flags & PRUS_OOB)) {
923 sbappendstream(&so->so_snd, m, flags);
924 if (nam && tp->t_state < TCPS_SYN_SENT) {
926 * Do implied connect if not yet connected,
927 * initialize window to default value, and
928 * initialize maxseg using peer's cached MSS.
932 error = tcp6_connect(tp, nam, td);
934 #if defined(INET6) && defined(INET)
938 error = tcp_connect(tp, nam, td);
942 tp->snd_wnd = TTCP_CLIENT_SND_WND;
945 if (flags & PRUS_EOF) {
947 * Close the send side of the connection after
950 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
954 if (!(inp->inp_flags & INP_DROPPED) &&
955 !(flags & PRUS_NOTREADY)) {
956 if (flags & PRUS_MORETOCOME)
957 tp->t_flags |= TF_MORETOCOME;
958 error = tp->t_fb->tfb_tcp_output(tp);
959 if (flags & PRUS_MORETOCOME)
960 tp->t_flags &= ~TF_MORETOCOME;
964 * XXXRW: PRUS_EOF not implemented with PRUS_OOB?
966 SOCKBUF_LOCK(&so->so_snd);
967 if (sbspace(&so->so_snd) < -512) {
968 SOCKBUF_UNLOCK(&so->so_snd);
974 * According to RFC961 (Assigned Protocols),
975 * the urgent pointer points to the last octet
976 * of urgent data. We continue, however,
977 * to consider it to indicate the first octet
978 * of data past the urgent section.
979 * Otherwise, snd_up should be one lower.
981 sbappendstream_locked(&so->so_snd, m, flags);
982 SOCKBUF_UNLOCK(&so->so_snd);
983 if (nam && tp->t_state < TCPS_SYN_SENT) {
985 * Do implied connect if not yet connected,
986 * initialize window to default value, and
987 * initialize maxseg using peer's cached MSS.
991 error = tcp6_connect(tp, nam, td);
993 #if defined(INET6) && defined(INET)
997 error = tcp_connect(tp, nam, td);
1001 tp->snd_wnd = TTCP_CLIENT_SND_WND;
1004 tp->snd_up = tp->snd_una + sbavail(&so->so_snd);
1005 if (!(flags & PRUS_NOTREADY)) {
1006 tp->t_flags |= TF_FORCEDATA;
1007 error = tp->t_fb->tfb_tcp_output(tp);
1008 tp->t_flags &= ~TF_FORCEDATA;
1012 TCPDEBUG2((flags & PRUS_OOB) ? PRU_SENDOOB :
1013 ((flags & PRUS_EOF) ? PRU_SEND_EOF : PRU_SEND));
1014 TCP_PROBE2(debug__user, tp, (flags & PRUS_OOB) ? PRU_SENDOOB :
1015 ((flags & PRUS_EOF) ? PRU_SEND_EOF : PRU_SEND));
1017 if (flags & PRUS_EOF)
1018 INP_INFO_RUNLOCK(&V_tcbinfo);
1023 tcp_usr_ready(struct socket *so, struct mbuf *m, int count)
1029 inp = sotoinpcb(so);
1031 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1033 for (int i = 0; i < count; i++)
1035 return (ECONNRESET);
1037 tp = intotcpcb(inp);
1039 SOCKBUF_LOCK(&so->so_snd);
1040 error = sbready(&so->so_snd, m, count);
1041 SOCKBUF_UNLOCK(&so->so_snd);
1043 error = tp->t_fb->tfb_tcp_output(tp);
1050 * Abort the TCP. Drop the connection abruptly.
1053 tcp_usr_abort(struct socket *so)
1056 struct tcpcb *tp = NULL;
1059 inp = sotoinpcb(so);
1060 KASSERT(inp != NULL, ("tcp_usr_abort: inp == NULL"));
1062 INP_INFO_RLOCK(&V_tcbinfo);
1064 KASSERT(inp->inp_socket != NULL,
1065 ("tcp_usr_abort: inp_socket == NULL"));
1068 * If we still have full TCP state, and we're not dropped, drop.
1070 if (!(inp->inp_flags & INP_TIMEWAIT) &&
1071 !(inp->inp_flags & INP_DROPPED)) {
1072 tp = intotcpcb(inp);
1074 tcp_drop(tp, ECONNABORTED);
1075 TCPDEBUG2(PRU_ABORT);
1076 TCP_PROBE2(debug__user, tp, PRU_ABORT);
1078 if (!(inp->inp_flags & INP_DROPPED)) {
1080 so->so_state |= SS_PROTOREF;
1082 inp->inp_flags |= INP_SOCKREF;
1085 INP_INFO_RUNLOCK(&V_tcbinfo);
1089 * TCP socket is closed. Start friendly disconnect.
1092 tcp_usr_close(struct socket *so)
1095 struct tcpcb *tp = NULL;
1098 inp = sotoinpcb(so);
1099 KASSERT(inp != NULL, ("tcp_usr_close: inp == NULL"));
1101 INP_INFO_RLOCK(&V_tcbinfo);
1103 KASSERT(inp->inp_socket != NULL,
1104 ("tcp_usr_close: inp_socket == NULL"));
1107 * If we still have full TCP state, and we're not dropped, initiate
1110 if (!(inp->inp_flags & INP_TIMEWAIT) &&
1111 !(inp->inp_flags & INP_DROPPED)) {
1112 tp = intotcpcb(inp);
1115 TCPDEBUG2(PRU_CLOSE);
1116 TCP_PROBE2(debug__user, tp, PRU_CLOSE);
1118 if (!(inp->inp_flags & INP_DROPPED)) {
1120 so->so_state |= SS_PROTOREF;
1122 inp->inp_flags |= INP_SOCKREF;
1125 INP_INFO_RUNLOCK(&V_tcbinfo);
1129 * Receive out-of-band data.
1132 tcp_usr_rcvoob(struct socket *so, struct mbuf *m, int flags)
1136 struct tcpcb *tp = NULL;
1139 inp = sotoinpcb(so);
1140 KASSERT(inp != NULL, ("tcp_usr_rcvoob: inp == NULL"));
1142 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1146 tp = intotcpcb(inp);
1148 if ((so->so_oobmark == 0 &&
1149 (so->so_rcv.sb_state & SBS_RCVATMARK) == 0) ||
1150 so->so_options & SO_OOBINLINE ||
1151 tp->t_oobflags & TCPOOB_HADDATA) {
1155 if ((tp->t_oobflags & TCPOOB_HAVEDATA) == 0) {
1156 error = EWOULDBLOCK;
1160 *mtod(m, caddr_t) = tp->t_iobc;
1161 if ((flags & MSG_PEEK) == 0)
1162 tp->t_oobflags ^= (TCPOOB_HAVEDATA | TCPOOB_HADDATA);
1165 TCPDEBUG2(PRU_RCVOOB);
1166 TCP_PROBE2(debug__user, tp, PRU_RCVOOB);
1172 struct pr_usrreqs tcp_usrreqs = {
1173 .pru_abort = tcp_usr_abort,
1174 .pru_accept = tcp_usr_accept,
1175 .pru_attach = tcp_usr_attach,
1176 .pru_bind = tcp_usr_bind,
1177 .pru_connect = tcp_usr_connect,
1178 .pru_control = in_control,
1179 .pru_detach = tcp_usr_detach,
1180 .pru_disconnect = tcp_usr_disconnect,
1181 .pru_listen = tcp_usr_listen,
1182 .pru_peeraddr = in_getpeeraddr,
1183 .pru_rcvd = tcp_usr_rcvd,
1184 .pru_rcvoob = tcp_usr_rcvoob,
1185 .pru_send = tcp_usr_send,
1186 .pru_ready = tcp_usr_ready,
1187 .pru_shutdown = tcp_usr_shutdown,
1188 .pru_sockaddr = in_getsockaddr,
1189 .pru_sosetlabel = in_pcbsosetlabel,
1190 .pru_close = tcp_usr_close,
1195 struct pr_usrreqs tcp6_usrreqs = {
1196 .pru_abort = tcp_usr_abort,
1197 .pru_accept = tcp6_usr_accept,
1198 .pru_attach = tcp_usr_attach,
1199 .pru_bind = tcp6_usr_bind,
1200 .pru_connect = tcp6_usr_connect,
1201 .pru_control = in6_control,
1202 .pru_detach = tcp_usr_detach,
1203 .pru_disconnect = tcp_usr_disconnect,
1204 .pru_listen = tcp6_usr_listen,
1205 .pru_peeraddr = in6_mapped_peeraddr,
1206 .pru_rcvd = tcp_usr_rcvd,
1207 .pru_rcvoob = tcp_usr_rcvoob,
1208 .pru_send = tcp_usr_send,
1209 .pru_ready = tcp_usr_ready,
1210 .pru_shutdown = tcp_usr_shutdown,
1211 .pru_sockaddr = in6_mapped_sockaddr,
1212 .pru_sosetlabel = in_pcbsosetlabel,
1213 .pru_close = tcp_usr_close,
1219 * Common subroutine to open a TCP connection to remote host specified
1220 * by struct sockaddr_in in mbuf *nam. Call in_pcbbind to assign a local
1221 * port number if needed. Call in_pcbconnect_setup to do the routing and
1222 * to choose a local host address (interface). If there is an existing
1223 * incarnation of the same connection in TIME-WAIT state and if the remote
1224 * host was sending CC options and if the connection duration was < MSL, then
1225 * truncate the previous TIME-WAIT state and proceed.
1226 * Initialize connection parameters and enter SYN-SENT state.
1229 tcp_connect(struct tcpcb *tp, struct sockaddr *nam, struct thread *td)
1231 struct inpcb *inp = tp->t_inpcb, *oinp;
1232 struct socket *so = inp->inp_socket;
1233 struct in_addr laddr;
1237 INP_WLOCK_ASSERT(inp);
1238 INP_HASH_WLOCK(&V_tcbinfo);
1240 if (inp->inp_lport == 0) {
1241 error = in_pcbbind(inp, (struct sockaddr *)0, td->td_ucred);
1247 * Cannot simply call in_pcbconnect, because there might be an
1248 * earlier incarnation of this same connection still in
1249 * TIME_WAIT state, creating an ADDRINUSE error.
1251 laddr = inp->inp_laddr;
1252 lport = inp->inp_lport;
1253 error = in_pcbconnect_setup(inp, nam, &laddr.s_addr, &lport,
1254 &inp->inp_faddr.s_addr, &inp->inp_fport, &oinp, td->td_ucred);
1255 if (error && oinp == NULL)
1261 inp->inp_laddr = laddr;
1263 INP_HASH_WUNLOCK(&V_tcbinfo);
1266 * Compute window scaling to request:
1267 * Scale to fit into sweet spot. See tcp_syncache.c.
1268 * XXX: This should move to tcp_output().
1270 while (tp->request_r_scale < TCP_MAX_WINSHIFT &&
1271 (TCP_MAXWIN << tp->request_r_scale) < sb_max)
1272 tp->request_r_scale++;
1275 TCPSTAT_INC(tcps_connattempt);
1276 tcp_state_change(tp, TCPS_SYN_SENT);
1277 tp->iss = tcp_new_isn(tp);
1278 tcp_sendseqinit(tp);
1283 INP_HASH_WUNLOCK(&V_tcbinfo);
1290 tcp6_connect(struct tcpcb *tp, struct sockaddr *nam, struct thread *td)
1292 struct inpcb *inp = tp->t_inpcb;
1295 INP_WLOCK_ASSERT(inp);
1296 INP_HASH_WLOCK(&V_tcbinfo);
1298 if (inp->inp_lport == 0) {
1299 error = in6_pcbbind(inp, (struct sockaddr *)0, td->td_ucred);
1303 error = in6_pcbconnect(inp, nam, td->td_ucred);
1306 INP_HASH_WUNLOCK(&V_tcbinfo);
1308 /* Compute window scaling to request. */
1309 while (tp->request_r_scale < TCP_MAX_WINSHIFT &&
1310 (TCP_MAXWIN << tp->request_r_scale) < sb_max)
1311 tp->request_r_scale++;
1313 soisconnecting(inp->inp_socket);
1314 TCPSTAT_INC(tcps_connattempt);
1315 tcp_state_change(tp, TCPS_SYN_SENT);
1316 tp->iss = tcp_new_isn(tp);
1317 tcp_sendseqinit(tp);
1322 INP_HASH_WUNLOCK(&V_tcbinfo);
1328 * Export TCP internal state information via a struct tcp_info, based on the
1329 * Linux 2.6 API. Not ABI compatible as our constants are mapped differently
1330 * (TCP state machine, etc). We export all information using FreeBSD-native
1331 * constants -- for example, the numeric values for tcpi_state will differ
1335 tcp_fill_info(struct tcpcb *tp, struct tcp_info *ti)
1338 INP_WLOCK_ASSERT(tp->t_inpcb);
1339 bzero(ti, sizeof(*ti));
1341 ti->tcpi_state = tp->t_state;
1342 if ((tp->t_flags & TF_REQ_TSTMP) && (tp->t_flags & TF_RCVD_TSTMP))
1343 ti->tcpi_options |= TCPI_OPT_TIMESTAMPS;
1344 if (tp->t_flags & TF_SACK_PERMIT)
1345 ti->tcpi_options |= TCPI_OPT_SACK;
1346 if ((tp->t_flags & TF_REQ_SCALE) && (tp->t_flags & TF_RCVD_SCALE)) {
1347 ti->tcpi_options |= TCPI_OPT_WSCALE;
1348 ti->tcpi_snd_wscale = tp->snd_scale;
1349 ti->tcpi_rcv_wscale = tp->rcv_scale;
1351 if (tp->t_flags & TF_ECN_PERMIT)
1352 ti->tcpi_options |= TCPI_OPT_ECN;
1354 ti->tcpi_rto = tp->t_rxtcur * tick;
1355 ti->tcpi_last_data_recv = (long)(ticks - (int)tp->t_rcvtime) * tick;
1356 ti->tcpi_rtt = ((u_int64_t)tp->t_srtt * tick) >> TCP_RTT_SHIFT;
1357 ti->tcpi_rttvar = ((u_int64_t)tp->t_rttvar * tick) >> TCP_RTTVAR_SHIFT;
1359 ti->tcpi_snd_ssthresh = tp->snd_ssthresh;
1360 ti->tcpi_snd_cwnd = tp->snd_cwnd;
1363 * FreeBSD-specific extension fields for tcp_info.
1365 ti->tcpi_rcv_space = tp->rcv_wnd;
1366 ti->tcpi_rcv_nxt = tp->rcv_nxt;
1367 ti->tcpi_snd_wnd = tp->snd_wnd;
1368 ti->tcpi_snd_bwnd = 0; /* Unused, kept for compat. */
1369 ti->tcpi_snd_nxt = tp->snd_nxt;
1370 ti->tcpi_snd_mss = tp->t_maxseg;
1371 ti->tcpi_rcv_mss = tp->t_maxseg;
1372 if (tp->t_flags & TF_TOE)
1373 ti->tcpi_options |= TCPI_OPT_TOE;
1374 ti->tcpi_snd_rexmitpack = tp->t_sndrexmitpack;
1375 ti->tcpi_rcv_ooopack = tp->t_rcvoopack;
1376 ti->tcpi_snd_zerowin = tp->t_sndzerowin;
1380 * tcp_ctloutput() must drop the inpcb lock before performing copyin on
1381 * socket option arguments. When it re-acquires the lock after the copy, it
1382 * has to revalidate that the connection is still valid for the socket
1385 #define INP_WLOCK_RECHECK_CLEANUP(inp, cleanup) do { \
1387 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) { \
1390 return (ECONNRESET); \
1392 tp = intotcpcb(inp); \
1394 #define INP_WLOCK_RECHECK(inp) INP_WLOCK_RECHECK_CLEANUP((inp), /* noop */)
1397 tcp_ctloutput(struct socket *so, struct sockopt *sopt)
1402 struct tcp_function_block *blk;
1403 struct tcp_function_set fsn;
1406 inp = sotoinpcb(so);
1407 KASSERT(inp != NULL, ("tcp_ctloutput: inp == NULL"));
1409 if (sopt->sopt_level != IPPROTO_TCP) {
1411 if (inp->inp_vflag & INP_IPV6PROTO) {
1413 error = ip6_ctloutput(so, sopt);
1416 #if defined(INET6) && defined(INET)
1422 error = ip_ctloutput(so, sopt);
1427 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
1429 return (ECONNRESET);
1431 tp = intotcpcb(inp);
1433 * Protect the TCP option TCP_FUNCTION_BLK so
1434 * that a sub-function can *never* overwrite this.
1436 if ((sopt->sopt_dir == SOPT_SET) &&
1437 (sopt->sopt_name == TCP_FUNCTION_BLK)) {
1439 error = sooptcopyin(sopt, &fsn, sizeof fsn,
1443 INP_WLOCK_RECHECK(inp);
1444 if (tp->t_state != TCPS_CLOSED) {
1446 * The user has advanced the state
1447 * past the initial point, we can't
1448 * switch since we are down the road
1449 * and a new set of functions may
1450 * not be compatibile.
1455 blk = find_and_ref_tcp_functions(&fsn);
1460 if (tp->t_fb != blk) {
1461 if (blk->tfb_flags & TCP_FUNC_BEING_REMOVED) {
1462 refcount_release(&blk->tfb_refcnt);
1467 * Release the old refcnt, the
1468 * lookup acquires a ref on the
1471 if (tp->t_fb->tfb_tcp_fb_fini)
1472 (*tp->t_fb->tfb_tcp_fb_fini)(tp);
1473 refcount_release(&tp->t_fb->tfb_refcnt);
1475 if (tp->t_fb->tfb_tcp_fb_init) {
1476 (*tp->t_fb->tfb_tcp_fb_init)(tp);
1480 if (tp->t_flags & TF_TOE) {
1481 tcp_offload_ctloutput(tp, sopt->sopt_dir,
1487 } else if ((sopt->sopt_dir == SOPT_GET) &&
1488 (sopt->sopt_name == TCP_FUNCTION_BLK)) {
1489 strcpy(fsn.function_set_name, tp->t_fb->tfb_tcp_block_name);
1490 fsn.pcbcnt = tp->t_fb->tfb_refcnt;
1492 error = sooptcopyout(sopt, &fsn, sizeof fsn);
1495 /* Pass in the INP locked, called must unlock it */
1496 return (tp->t_fb->tfb_tcp_ctloutput(so, sopt, inp, tp));
1500 tcp_default_ctloutput(struct socket *so, struct sockopt *sopt, struct inpcb *inp, struct tcpcb *tp)
1502 int error, opt, optval;
1505 struct cc_algo *algo;
1506 char *pbuf, buf[TCP_CA_NAME_MAX];
1510 * For TCP_CCALGOOPT forward the control to CC module, for both
1511 * SOPT_SET and SOPT_GET.
1513 switch (sopt->sopt_name) {
1516 pbuf = malloc(sopt->sopt_valsize, M_TEMP, M_WAITOK | M_ZERO);
1517 error = sooptcopyin(sopt, pbuf, sopt->sopt_valsize,
1518 sopt->sopt_valsize);
1523 INP_WLOCK_RECHECK_CLEANUP(inp, free(pbuf, M_TEMP));
1524 if (CC_ALGO(tp)->ctl_output != NULL)
1525 error = CC_ALGO(tp)->ctl_output(tp->ccv, sopt, pbuf);
1529 if (error == 0 && sopt->sopt_dir == SOPT_GET)
1530 error = sooptcopyout(sopt, pbuf, sopt->sopt_valsize);
1535 switch (sopt->sopt_dir) {
1537 switch (sopt->sopt_name) {
1538 #if defined(IPSEC_SUPPORT) || defined(TCP_SIGNATURE)
1540 if (!TCPMD5_ENABLED()) {
1542 return (ENOPROTOOPT);
1544 error = TCPMD5_PCBCTL(inp, sopt);
1547 goto unlock_and_done;
1553 error = sooptcopyin(sopt, &optval, sizeof optval,
1558 INP_WLOCK_RECHECK(inp);
1559 switch (sopt->sopt_name) {
1567 opt = 0; /* dead code to fool gcc */
1574 tp->t_flags &= ~opt;
1577 if (tp->t_flags & TF_TOE) {
1578 tcp_offload_ctloutput(tp, sopt->sopt_dir,
1587 error = sooptcopyin(sopt, &optval, sizeof optval,
1592 INP_WLOCK_RECHECK(inp);
1594 tp->t_flags |= TF_NOPUSH;
1595 else if (tp->t_flags & TF_NOPUSH) {
1596 tp->t_flags &= ~TF_NOPUSH;
1597 if (TCPS_HAVEESTABLISHED(tp->t_state))
1598 error = tp->t_fb->tfb_tcp_output(tp);
1600 goto unlock_and_done;
1604 error = sooptcopyin(sopt, &optval, sizeof optval,
1609 INP_WLOCK_RECHECK(inp);
1610 if (optval > 0 && optval <= tp->t_maxseg &&
1611 optval + 40 >= V_tcp_minmss)
1612 tp->t_maxseg = optval;
1615 goto unlock_and_done;
1622 case TCP_CONGESTION:
1624 error = sooptcopyin(sopt, buf, TCP_CA_NAME_MAX - 1, 1);
1627 buf[sopt->sopt_valsize] = '\0';
1628 INP_WLOCK_RECHECK(inp);
1630 STAILQ_FOREACH(algo, &cc_list, entries)
1631 if (strncmp(buf, algo->name,
1632 TCP_CA_NAME_MAX) == 0)
1641 * We hold a write lock over the tcb so it's safe to
1642 * do these things without ordering concerns.
1644 if (CC_ALGO(tp)->cb_destroy != NULL)
1645 CC_ALGO(tp)->cb_destroy(tp->ccv);
1648 * If something goes pear shaped initialising the new
1649 * algo, fall back to newreno (which does not
1650 * require initialisation).
1652 if (algo->cb_init != NULL &&
1653 algo->cb_init(tp->ccv) != 0) {
1654 CC_ALGO(tp) = &newreno_cc_algo;
1656 * The only reason init should fail is
1657 * because of malloc.
1668 error = sooptcopyin(sopt, &ui, sizeof(ui), sizeof(ui));
1672 if (ui > (UINT_MAX / hz)) {
1678 INP_WLOCK_RECHECK(inp);
1679 switch (sopt->sopt_name) {
1681 tp->t_keepidle = ui;
1683 * XXX: better check current remaining
1684 * timeout and "merge" it with new value.
1686 if ((tp->t_state > TCPS_LISTEN) &&
1687 (tp->t_state <= TCPS_CLOSING))
1688 tcp_timer_activate(tp, TT_KEEP,
1692 tp->t_keepintvl = ui;
1693 if ((tp->t_state == TCPS_FIN_WAIT_2) &&
1694 (TP_MAXIDLE(tp) > 0))
1695 tcp_timer_activate(tp, TT_2MSL,
1699 tp->t_keepinit = ui;
1700 if (tp->t_state == TCPS_SYN_RECEIVED ||
1701 tp->t_state == TCPS_SYN_SENT)
1702 tcp_timer_activate(tp, TT_KEEP,
1706 goto unlock_and_done;
1710 error = sooptcopyin(sopt, &ui, sizeof(ui), sizeof(ui));
1714 INP_WLOCK_RECHECK(inp);
1716 if ((tp->t_state == TCPS_FIN_WAIT_2) &&
1717 (TP_MAXIDLE(tp) > 0))
1718 tcp_timer_activate(tp, TT_2MSL,
1720 goto unlock_and_done;
1726 error = sooptcopyin(sopt, &optval, sizeof optval,
1731 INP_WLOCK_RECHECK(inp);
1733 tcp_pcap_set_sock_max(TCP_PCAP_OUT ?
1734 &(tp->t_outpkts) : &(tp->t_inpkts),
1738 goto unlock_and_done;
1744 if (!V_tcp_fastopen_enabled)
1747 error = sooptcopyin(sopt, &optval, sizeof optval,
1752 INP_WLOCK_RECHECK(inp);
1754 tp->t_flags |= TF_FASTOPEN;
1755 if ((tp->t_state == TCPS_LISTEN) &&
1756 (tp->t_tfo_pending == NULL))
1758 tcp_fastopen_alloc_counter();
1760 tp->t_flags &= ~TF_FASTOPEN;
1761 goto unlock_and_done;
1766 error = ENOPROTOOPT;
1772 tp = intotcpcb(inp);
1773 switch (sopt->sopt_name) {
1774 #if defined(IPSEC_SUPPORT) || defined(TCP_SIGNATURE)
1776 if (!TCPMD5_ENABLED()) {
1778 return (ENOPROTOOPT);
1780 error = TCPMD5_PCBCTL(inp, sopt);
1785 optval = tp->t_flags & TF_NODELAY;
1787 error = sooptcopyout(sopt, &optval, sizeof optval);
1790 optval = tp->t_maxseg;
1792 error = sooptcopyout(sopt, &optval, sizeof optval);
1795 optval = tp->t_flags & TF_NOOPT;
1797 error = sooptcopyout(sopt, &optval, sizeof optval);
1800 optval = tp->t_flags & TF_NOPUSH;
1802 error = sooptcopyout(sopt, &optval, sizeof optval);
1805 tcp_fill_info(tp, &ti);
1807 error = sooptcopyout(sopt, &ti, sizeof ti);
1809 case TCP_CONGESTION:
1810 len = strlcpy(buf, CC_ALGO(tp)->name, TCP_CA_NAME_MAX);
1812 error = sooptcopyout(sopt, buf, len + 1);
1818 switch (sopt->sopt_name) {
1820 ui = TP_KEEPIDLE(tp) / hz;
1823 ui = TP_KEEPINTVL(tp) / hz;
1826 ui = TP_KEEPINIT(tp) / hz;
1829 ui = TP_KEEPCNT(tp);
1833 error = sooptcopyout(sopt, &ui, sizeof(ui));
1838 optval = tcp_pcap_get_sock_max(TCP_PCAP_OUT ?
1839 &(tp->t_outpkts) : &(tp->t_inpkts));
1841 error = sooptcopyout(sopt, &optval, sizeof optval);
1847 optval = tp->t_flags & TF_FASTOPEN;
1849 error = sooptcopyout(sopt, &optval, sizeof optval);
1854 error = ENOPROTOOPT;
1861 #undef INP_WLOCK_RECHECK
1862 #undef INP_WLOCK_RECHECK_CLEANUP
1865 * Attach TCP protocol to socket, allocating
1866 * internet protocol control block, tcp control block,
1867 * bufer space, and entering LISTEN state if to accept connections.
1870 tcp_attach(struct socket *so)
1876 if (so->so_snd.sb_hiwat == 0 || so->so_rcv.sb_hiwat == 0) {
1877 error = soreserve(so, V_tcp_sendspace, V_tcp_recvspace);
1881 so->so_rcv.sb_flags |= SB_AUTOSIZE;
1882 so->so_snd.sb_flags |= SB_AUTOSIZE;
1883 INP_INFO_RLOCK(&V_tcbinfo);
1884 error = in_pcballoc(so, &V_tcbinfo);
1886 INP_INFO_RUNLOCK(&V_tcbinfo);
1889 inp = sotoinpcb(so);
1891 if (inp->inp_vflag & INP_IPV6PROTO) {
1892 inp->inp_vflag |= INP_IPV6;
1893 inp->in6p_hops = -1; /* use kernel default */
1897 inp->inp_vflag |= INP_IPV4;
1898 tp = tcp_newtcpcb(inp);
1902 INP_INFO_RUNLOCK(&V_tcbinfo);
1905 tp->t_state = TCPS_CLOSED;
1907 INP_INFO_RUNLOCK(&V_tcbinfo);
1908 TCPSTATES_INC(TCPS_CLOSED);
1913 * Initiate (or continue) disconnect.
1914 * If embryonic state, just send reset (once).
1915 * If in ``let data drain'' option and linger null, just drop.
1916 * Otherwise (hard), mark socket disconnecting and drop
1917 * current input data; switch states based on user close, and
1918 * send segment to peer (with FIN).
1921 tcp_disconnect(struct tcpcb *tp)
1923 struct inpcb *inp = tp->t_inpcb;
1924 struct socket *so = inp->inp_socket;
1926 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
1927 INP_WLOCK_ASSERT(inp);
1930 * Neither tcp_close() nor tcp_drop() should return NULL, as the
1931 * socket is still open.
1933 if (tp->t_state < TCPS_ESTABLISHED) {
1936 ("tcp_disconnect: tcp_close() returned NULL"));
1937 } else if ((so->so_options & SO_LINGER) && so->so_linger == 0) {
1938 tp = tcp_drop(tp, 0);
1940 ("tcp_disconnect: tcp_drop() returned NULL"));
1942 soisdisconnecting(so);
1943 sbflush(&so->so_rcv);
1945 if (!(inp->inp_flags & INP_DROPPED))
1946 tp->t_fb->tfb_tcp_output(tp);
1951 * User issued close, and wish to trail through shutdown states:
1952 * if never received SYN, just forget it. If got a SYN from peer,
1953 * but haven't sent FIN, then go to FIN_WAIT_1 state to send peer a FIN.
1954 * If already got a FIN from peer, then almost done; go to LAST_ACK
1955 * state. In all other cases, have already sent FIN to peer (e.g.
1956 * after PRU_SHUTDOWN), and just have to play tedious game waiting
1957 * for peer to send FIN or not respond to keep-alives, etc.
1958 * We can let the user exit from the close as soon as the FIN is acked.
1961 tcp_usrclosed(struct tcpcb *tp)
1964 INP_INFO_RLOCK_ASSERT(&V_tcbinfo);
1965 INP_WLOCK_ASSERT(tp->t_inpcb);
1967 switch (tp->t_state) {
1970 tcp_offload_listen_stop(tp);
1972 tcp_state_change(tp, TCPS_CLOSED);
1977 * tcp_close() should never return NULL here as the socket is
1981 ("tcp_usrclosed: tcp_close() returned NULL"));
1985 case TCPS_SYN_RECEIVED:
1986 tp->t_flags |= TF_NEEDFIN;
1989 case TCPS_ESTABLISHED:
1990 tcp_state_change(tp, TCPS_FIN_WAIT_1);
1993 case TCPS_CLOSE_WAIT:
1994 tcp_state_change(tp, TCPS_LAST_ACK);
1997 if (tp->t_state >= TCPS_FIN_WAIT_2) {
1998 soisdisconnected(tp->t_inpcb->inp_socket);
1999 /* Prevent the connection hanging in FIN_WAIT_2 forever. */
2000 if (tp->t_state == TCPS_FIN_WAIT_2) {
2003 timeout = (tcp_fast_finwait2_recycle) ?
2004 tcp_finwait2_timeout : TP_MAXIDLE(tp);
2005 tcp_timer_activate(tp, TT_2MSL, timeout);
2012 db_print_indent(int indent)
2016 for (i = 0; i < indent; i++)
2021 db_print_tstate(int t_state)
2026 db_printf("TCPS_CLOSED");
2030 db_printf("TCPS_LISTEN");
2034 db_printf("TCPS_SYN_SENT");
2037 case TCPS_SYN_RECEIVED:
2038 db_printf("TCPS_SYN_RECEIVED");
2041 case TCPS_ESTABLISHED:
2042 db_printf("TCPS_ESTABLISHED");
2045 case TCPS_CLOSE_WAIT:
2046 db_printf("TCPS_CLOSE_WAIT");
2049 case TCPS_FIN_WAIT_1:
2050 db_printf("TCPS_FIN_WAIT_1");
2054 db_printf("TCPS_CLOSING");
2058 db_printf("TCPS_LAST_ACK");
2061 case TCPS_FIN_WAIT_2:
2062 db_printf("TCPS_FIN_WAIT_2");
2065 case TCPS_TIME_WAIT:
2066 db_printf("TCPS_TIME_WAIT");
2070 db_printf("unknown");
2076 db_print_tflags(u_int t_flags)
2081 if (t_flags & TF_ACKNOW) {
2082 db_printf("%sTF_ACKNOW", comma ? ", " : "");
2085 if (t_flags & TF_DELACK) {
2086 db_printf("%sTF_DELACK", comma ? ", " : "");
2089 if (t_flags & TF_NODELAY) {
2090 db_printf("%sTF_NODELAY", comma ? ", " : "");
2093 if (t_flags & TF_NOOPT) {
2094 db_printf("%sTF_NOOPT", comma ? ", " : "");
2097 if (t_flags & TF_SENTFIN) {
2098 db_printf("%sTF_SENTFIN", comma ? ", " : "");
2101 if (t_flags & TF_REQ_SCALE) {
2102 db_printf("%sTF_REQ_SCALE", comma ? ", " : "");
2105 if (t_flags & TF_RCVD_SCALE) {
2106 db_printf("%sTF_RECVD_SCALE", comma ? ", " : "");
2109 if (t_flags & TF_REQ_TSTMP) {
2110 db_printf("%sTF_REQ_TSTMP", comma ? ", " : "");
2113 if (t_flags & TF_RCVD_TSTMP) {
2114 db_printf("%sTF_RCVD_TSTMP", comma ? ", " : "");
2117 if (t_flags & TF_SACK_PERMIT) {
2118 db_printf("%sTF_SACK_PERMIT", comma ? ", " : "");
2121 if (t_flags & TF_NEEDSYN) {
2122 db_printf("%sTF_NEEDSYN", comma ? ", " : "");
2125 if (t_flags & TF_NEEDFIN) {
2126 db_printf("%sTF_NEEDFIN", comma ? ", " : "");
2129 if (t_flags & TF_NOPUSH) {
2130 db_printf("%sTF_NOPUSH", comma ? ", " : "");
2133 if (t_flags & TF_MORETOCOME) {
2134 db_printf("%sTF_MORETOCOME", comma ? ", " : "");
2137 if (t_flags & TF_LQ_OVERFLOW) {
2138 db_printf("%sTF_LQ_OVERFLOW", comma ? ", " : "");
2141 if (t_flags & TF_LASTIDLE) {
2142 db_printf("%sTF_LASTIDLE", comma ? ", " : "");
2145 if (t_flags & TF_RXWIN0SENT) {
2146 db_printf("%sTF_RXWIN0SENT", comma ? ", " : "");
2149 if (t_flags & TF_FASTRECOVERY) {
2150 db_printf("%sTF_FASTRECOVERY", comma ? ", " : "");
2153 if (t_flags & TF_CONGRECOVERY) {
2154 db_printf("%sTF_CONGRECOVERY", comma ? ", " : "");
2157 if (t_flags & TF_WASFRECOVERY) {
2158 db_printf("%sTF_WASFRECOVERY", comma ? ", " : "");
2161 if (t_flags & TF_SIGNATURE) {
2162 db_printf("%sTF_SIGNATURE", comma ? ", " : "");
2165 if (t_flags & TF_FORCEDATA) {
2166 db_printf("%sTF_FORCEDATA", comma ? ", " : "");
2169 if (t_flags & TF_TSO) {
2170 db_printf("%sTF_TSO", comma ? ", " : "");
2173 if (t_flags & TF_ECN_PERMIT) {
2174 db_printf("%sTF_ECN_PERMIT", comma ? ", " : "");
2177 if (t_flags & TF_FASTOPEN) {
2178 db_printf("%sTF_FASTOPEN", comma ? ", " : "");
2184 db_print_toobflags(char t_oobflags)
2189 if (t_oobflags & TCPOOB_HAVEDATA) {
2190 db_printf("%sTCPOOB_HAVEDATA", comma ? ", " : "");
2193 if (t_oobflags & TCPOOB_HADDATA) {
2194 db_printf("%sTCPOOB_HADDATA", comma ? ", " : "");
2200 db_print_tcpcb(struct tcpcb *tp, const char *name, int indent)
2203 db_print_indent(indent);
2204 db_printf("%s at %p\n", name, tp);
2208 db_print_indent(indent);
2209 db_printf("t_segq first: %p t_segqlen: %d t_dupacks: %d\n",
2210 LIST_FIRST(&tp->t_segq), tp->t_segqlen, tp->t_dupacks);
2212 db_print_indent(indent);
2213 db_printf("tt_rexmt: %p tt_persist: %p tt_keep: %p\n",
2214 &tp->t_timers->tt_rexmt, &tp->t_timers->tt_persist, &tp->t_timers->tt_keep);
2216 db_print_indent(indent);
2217 db_printf("tt_2msl: %p tt_delack: %p t_inpcb: %p\n", &tp->t_timers->tt_2msl,
2218 &tp->t_timers->tt_delack, tp->t_inpcb);
2220 db_print_indent(indent);
2221 db_printf("t_state: %d (", tp->t_state);
2222 db_print_tstate(tp->t_state);
2225 db_print_indent(indent);
2226 db_printf("t_flags: 0x%x (", tp->t_flags);
2227 db_print_tflags(tp->t_flags);
2230 db_print_indent(indent);
2231 db_printf("snd_una: 0x%08x snd_max: 0x%08x snd_nxt: x0%08x\n",
2232 tp->snd_una, tp->snd_max, tp->snd_nxt);
2234 db_print_indent(indent);
2235 db_printf("snd_up: 0x%08x snd_wl1: 0x%08x snd_wl2: 0x%08x\n",
2236 tp->snd_up, tp->snd_wl1, tp->snd_wl2);
2238 db_print_indent(indent);
2239 db_printf("iss: 0x%08x irs: 0x%08x rcv_nxt: 0x%08x\n",
2240 tp->iss, tp->irs, tp->rcv_nxt);
2242 db_print_indent(indent);
2243 db_printf("rcv_adv: 0x%08x rcv_wnd: %lu rcv_up: 0x%08x\n",
2244 tp->rcv_adv, tp->rcv_wnd, tp->rcv_up);
2246 db_print_indent(indent);
2247 db_printf("snd_wnd: %lu snd_cwnd: %lu\n",
2248 tp->snd_wnd, tp->snd_cwnd);
2250 db_print_indent(indent);
2251 db_printf("snd_ssthresh: %lu snd_recover: "
2252 "0x%08x\n", tp->snd_ssthresh, tp->snd_recover);
2254 db_print_indent(indent);
2255 db_printf("t_rcvtime: %u t_startime: %u\n",
2256 tp->t_rcvtime, tp->t_starttime);
2258 db_print_indent(indent);
2259 db_printf("t_rttime: %u t_rtsq: 0x%08x\n",
2260 tp->t_rtttime, tp->t_rtseq);
2262 db_print_indent(indent);
2263 db_printf("t_rxtcur: %d t_maxseg: %u t_srtt: %d\n",
2264 tp->t_rxtcur, tp->t_maxseg, tp->t_srtt);
2266 db_print_indent(indent);
2267 db_printf("t_rttvar: %d t_rxtshift: %d t_rttmin: %u "
2268 "t_rttbest: %u\n", tp->t_rttvar, tp->t_rxtshift, tp->t_rttmin,
2271 db_print_indent(indent);
2272 db_printf("t_rttupdated: %lu max_sndwnd: %lu t_softerror: %d\n",
2273 tp->t_rttupdated, tp->max_sndwnd, tp->t_softerror);
2275 db_print_indent(indent);
2276 db_printf("t_oobflags: 0x%x (", tp->t_oobflags);
2277 db_print_toobflags(tp->t_oobflags);
2278 db_printf(") t_iobc: 0x%02x\n", tp->t_iobc);
2280 db_print_indent(indent);
2281 db_printf("snd_scale: %u rcv_scale: %u request_r_scale: %u\n",
2282 tp->snd_scale, tp->rcv_scale, tp->request_r_scale);
2284 db_print_indent(indent);
2285 db_printf("ts_recent: %u ts_recent_age: %u\n",
2286 tp->ts_recent, tp->ts_recent_age);
2288 db_print_indent(indent);
2289 db_printf("ts_offset: %u last_ack_sent: 0x%08x snd_cwnd_prev: "
2290 "%lu\n", tp->ts_offset, tp->last_ack_sent, tp->snd_cwnd_prev);
2292 db_print_indent(indent);
2293 db_printf("snd_ssthresh_prev: %lu snd_recover_prev: 0x%08x "
2294 "t_badrxtwin: %u\n", tp->snd_ssthresh_prev,
2295 tp->snd_recover_prev, tp->t_badrxtwin);
2297 db_print_indent(indent);
2298 db_printf("snd_numholes: %d snd_holes first: %p\n",
2299 tp->snd_numholes, TAILQ_FIRST(&tp->snd_holes));
2301 db_print_indent(indent);
2302 db_printf("snd_fack: 0x%08x rcv_numsacks: %d sack_newdata: "
2303 "0x%08x\n", tp->snd_fack, tp->rcv_numsacks, tp->sack_newdata);
2305 /* Skip sackblks, sackhint. */
2307 db_print_indent(indent);
2308 db_printf("t_rttlow: %d rfbuf_ts: %u rfbuf_cnt: %d\n",
2309 tp->t_rttlow, tp->rfbuf_ts, tp->rfbuf_cnt);
2312 DB_SHOW_COMMAND(tcpcb, db_show_tcpcb)
2317 db_printf("usage: show tcpcb <addr>\n");
2320 tp = (struct tcpcb *)addr;
2322 db_print_tcpcb(tp, "tcpcb", 0);