xref: /freebsd/share/man/man4/tcp.4 (revision 5b20c5e1f8d59f14901f0c0e4b6b577eaa3f9569)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.
3.\" Copyright (c) 2010-2011 The FreeBSD Foundation
4.\" All rights reserved.
5.\"
6.\" Portions of this documentation were written at the Centre for Advanced
7.\" Internet Architectures, Swinburne University of Technology, Melbourne,
8.\" Australia by David Hayes under sponsorship from the FreeBSD Foundation.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     From: @(#)tcp.4	8.1 (Berkeley) 6/5/93
35.\" $FreeBSD$
36.\"
37.Dd April 8, 2021
38.Dt TCP 4
39.Os
40.Sh NAME
41.Nm tcp
42.Nd Internet Transmission Control Protocol
43.Sh SYNOPSIS
44.In sys/types.h
45.In sys/socket.h
46.In netinet/in.h
47.In netinet/tcp.h
48.Ft int
49.Fn socket AF_INET SOCK_STREAM 0
50.Sh DESCRIPTION
51The
52.Tn TCP
53protocol provides reliable, flow-controlled, two-way
54transmission of data.
55It is a byte-stream protocol used to
56support the
57.Dv SOCK_STREAM
58abstraction.
59.Tn TCP
60uses the standard
61Internet address format and, in addition, provides a per-host
62collection of
63.Dq "port addresses" .
64Thus, each address is composed
65of an Internet address specifying the host and network,
66with a specific
67.Tn TCP
68port on the host identifying the peer entity.
69.Pp
70Sockets utilizing the
71.Tn TCP
72protocol are either
73.Dq active
74or
75.Dq passive .
76Active sockets initiate connections to passive
77sockets.
78By default,
79.Tn TCP
80sockets are created active; to create a
81passive socket, the
82.Xr listen 2
83system call must be used
84after binding the socket with the
85.Xr bind 2
86system call.
87Only passive sockets may use the
88.Xr accept 2
89call to accept incoming connections.
90Only active sockets may use the
91.Xr connect 2
92call to initiate connections.
93.Pp
94Passive sockets may
95.Dq underspecify
96their location to match
97incoming connection requests from multiple networks.
98This technique, termed
99.Dq "wildcard addressing" ,
100allows a single
101server to provide service to clients on multiple networks.
102To create a socket which listens on all networks, the Internet
103address
104.Dv INADDR_ANY
105must be bound.
106The
107.Tn TCP
108port may still be specified
109at this time; if the port is not specified, the system will assign one.
110Once a connection has been established, the socket's address is
111fixed by the peer entity's location.
112The address assigned to the
113socket is the address associated with the network interface
114through which packets are being transmitted and received.
115Normally, this address corresponds to the peer entity's network.
116.Pp
117.Tn TCP
118supports a number of socket options which can be set with
119.Xr setsockopt 2
120and tested with
121.Xr getsockopt 2 :
122.Bl -tag -width ".Dv TCP_FUNCTION_BLK"
123.It Dv TCP_INFO
124Information about a socket's underlying TCP session may be retrieved
125by passing the read-only option
126.Dv TCP_INFO
127to
128.Xr getsockopt 2 .
129It accepts a single argument: a pointer to an instance of
130.Vt "struct tcp_info" .
131.Pp
132This API is subject to change; consult the source to determine
133which fields are currently filled out by this option.
134.Fx
135specific additions include
136send window size,
137receive window size,
138and
139bandwidth-controlled window space.
140.It Dv TCP_CCALGOOPT
141Set or query congestion control algorithm specific parameters.
142See
143.Xr mod_cc 4
144for details.
145.It Dv TCP_CONGESTION
146Select or query the congestion control algorithm that TCP will use for the
147connection.
148See
149.Xr mod_cc 4
150for details.
151.It Dv TCP_FUNCTION_BLK
152Select or query the set of functions that TCP will use for this connection.
153This allows a user to select an alternate TCP stack.
154The alternate TCP stack must already be loaded in the kernel.
155To list the available TCP stacks, see
156.Va functions_available
157in the
158.Sx MIB Variables
159section further down.
160To list the default TCP stack, see
161.Va functions_default
162in the
163.Sx MIB Variables
164section.
165.It Dv TCP_KEEPINIT
166This
167.Xr setsockopt 2
168option accepts a per-socket timeout argument of
169.Vt "u_int"
170in seconds, for new, non-established
171.Tn TCP
172connections.
173For the global default in milliseconds see
174.Va keepinit
175in the
176.Sx MIB Variables
177section further down.
178.It Dv TCP_KEEPIDLE
179This
180.Xr setsockopt 2
181option accepts an argument of
182.Vt "u_int"
183for the amount of time, in seconds, that the connection must be idle
184before keepalive probes (if enabled) are sent for the connection of this
185socket.
186If set on a listening socket, the value is inherited by the newly created
187socket upon
188.Xr accept 2 .
189For the global default in milliseconds see
190.Va keepidle
191in the
192.Sx MIB Variables
193section further down.
194.It Dv TCP_KEEPINTVL
195This
196.Xr setsockopt 2
197option accepts an argument of
198.Vt "u_int"
199to set the per-socket interval, in seconds, between keepalive probes sent
200to a peer.
201If set on a listening socket, the value is inherited by the newly created
202socket upon
203.Xr accept 2 .
204For the global default in milliseconds see
205.Va keepintvl
206in the
207.Sx MIB Variables
208section further down.
209.It Dv TCP_KEEPCNT
210This
211.Xr setsockopt 2
212option accepts an argument of
213.Vt "u_int"
214and allows a per-socket tuning of the number of probes sent, with no response,
215before the connection will be dropped.
216If set on a listening socket, the value is inherited by the newly created
217socket upon
218.Xr accept 2 .
219For the global default see the
220.Va keepcnt
221in the
222.Sx MIB Variables
223section further down.
224.It Dv TCP_NODELAY
225Under most circumstances,
226.Tn TCP
227sends data when it is presented;
228when outstanding data has not yet been acknowledged, it gathers
229small amounts of output to be sent in a single packet once
230an acknowledgement is received.
231For a small number of clients, such as window systems
232that send a stream of mouse events which receive no replies,
233this packetization may cause significant delays.
234The boolean option
235.Dv TCP_NODELAY
236defeats this algorithm.
237.It Dv TCP_MAXSEG
238By default, a sender- and
239.No receiver- Ns Tn TCP
240will negotiate among themselves to determine the maximum segment size
241to be used for each connection.
242The
243.Dv TCP_MAXSEG
244option allows the user to determine the result of this negotiation,
245and to reduce it if desired.
246.It Dv TCP_NOOPT
247.Tn TCP
248usually sends a number of options in each packet, corresponding to
249various
250.Tn TCP
251extensions which are provided in this implementation.
252The boolean option
253.Dv TCP_NOOPT
254is provided to disable
255.Tn TCP
256option use on a per-connection basis.
257.It Dv TCP_NOPUSH
258By convention, the
259.No sender- Ns Tn TCP
260will set the
261.Dq push
262bit, and begin transmission immediately (if permitted) at the end of
263every user call to
264.Xr write 2
265or
266.Xr writev 2 .
267When this option is set to a non-zero value,
268.Tn TCP
269will delay sending any data at all until either the socket is closed,
270or the internal send buffer is filled.
271.It Dv TCP_MD5SIG
272This option enables the use of MD5 digests (also known as TCP-MD5)
273on writes to the specified socket.
274Outgoing traffic is digested;
275digests on incoming traffic are verified.
276When this option is enabled on a socket, all inbound and outgoing
277TCP segments must be signed with MD5 digests.
278.Pp
279One common use for this in a
280.Fx
281router deployment is to enable
282based routers to interwork with Cisco equipment at peering points.
283Support for this feature conforms to RFC 2385.
284.Pp
285In order for this option to function correctly, it is necessary for the
286administrator to add a tcp-md5 key entry to the system's security
287associations database (SADB) using the
288.Xr setkey 8
289utility.
290This entry can only be specified on a per-host basis at this time.
291.Pp
292If an SADB entry cannot be found for the destination,
293the system does not send any outgoing segments and drops any inbound segments.
294.It Dv TCP_STATS
295Manage collection of connection level statistics using the
296.Xr stats 3
297framework.
298.Pp
299Each dropped segment is taken into account in the TCP protocol statistics.
300.It Dv TCP_TXTLS_ENABLE
301Enable in-kernel Transport Layer Security (TLS) for data written to this
302socket.
303See
304.Xr ktls 4
305for more details.
306.It Dv TCP_TXTLS_MODE
307The integer argument can be used to get or set the current TLS transmit mode
308of a socket.
309See
310.Xr ktls 4
311for more details.
312.It Dv TCP_RXTLS_ENABLE
313Enable in-kernel TLS for data read from this socket.
314See
315.Xr ktls 4
316for more details.
317.It Dv TCP_REUSPORT_LB_NUMA
318Changes NUMA affinity filtering for an established TCP listen
319socket.
320This option takes a single integer argument which specifies
321the NUMA domain to filter on for this listen socket.
322The argument can also have the follwing special values:
323.Bl -tag -width "Dv TCP_REUSPORT_LB_NUMA"
324.It Dv TCP_REUSPORT_LB_NUMA_NODOM
325Remove NUMA filtering for this listen socket.
326.It Dv TCP_REUSPORT_LB_NUMA_CURDOM
327Filter traffic associated with the domain where the calling thread is
328currently executing.
329This is typically used after a process or thread inherits a listen
330socket from its parent, and sets its CPU affinity to a particular core.
331.El
332.El
333.Pp
334The option level for the
335.Xr setsockopt 2
336call is the protocol number for
337.Tn TCP ,
338available from
339.Xr getprotobyname 3 ,
340or
341.Dv IPPROTO_TCP .
342All options are declared in
343.In netinet/tcp.h .
344.Pp
345Options at the
346.Tn IP
347transport level may be used with
348.Tn TCP ;
349see
350.Xr ip 4 .
351Incoming connection requests that are source-routed are noted,
352and the reverse source route is used in responding.
353.Pp
354The default congestion control algorithm for
355.Tn TCP
356is
357.Xr cc_newreno 4 .
358Other congestion control algorithms can be made available using the
359.Xr mod_cc 4
360framework.
361.Ss MIB Variables
362The
363.Tn TCP
364protocol implements a number of variables in the
365.Va net.inet.tcp
366branch of the
367.Xr sysctl 3
368MIB.
369.Bl -tag -width ".Va TCPCTL_DO_RFC1323"
370.It Dv TCPCTL_DO_RFC1323
371.Pq Va rfc1323
372Implement the window scaling and timestamp options of RFC 1323/RFC 7323
373(default is true).
374.It Va tolerate_missing_ts
375Tolerate the missing of timestamps (RFC 1323/RFC 7323) for
376.Tn TCP
377segments belonging to
378.Tn TCP
379connections for which support of
380.Tn TCP
381timestamps has been negotiated.
382(default is 0, i.e., the missing of timestamps is not tolerated).
383.It Dv TCPCTL_MSSDFLT
384.Pq Va mssdflt
385The default value used for the maximum segment size
386.Pq Dq MSS
387when no advice to the contrary is received from MSS negotiation.
388.It Dv TCPCTL_SENDSPACE
389.Pq Va sendspace
390Maximum
391.Tn TCP
392send window.
393.It Dv TCPCTL_RECVSPACE
394.Pq Va recvspace
395Maximum
396.Tn TCP
397receive window.
398.It Va log_in_vain
399Log any connection attempts to ports where there is not a socket
400accepting connections.
401The value of 1 limits the logging to
402.Tn SYN
403(connection establishment) packets only.
404That of 2 results in any
405.Tn TCP
406packets to closed ports being logged.
407Any value unlisted above disables the logging
408(default is 0, i.e., the logging is disabled).
409.It Va msl
410The Maximum Segment Lifetime, in milliseconds, for a packet.
411.It Va keepinit
412Timeout, in milliseconds, for new, non-established
413.Tn TCP
414connections.
415The default is 75000 msec.
416.It Va keepidle
417Amount of time, in milliseconds, that the connection must be idle
418before keepalive probes (if enabled) are sent.
419The default is 7200000 msec (2 hours).
420.It Va keepintvl
421The interval, in milliseconds, between keepalive probes sent to remote
422machines, when no response is received on a
423.Va keepidle
424probe.
425The default is 75000 msec.
426.It Va keepcnt
427Number of probes sent, with no response, before a connection
428is dropped.
429The default is 8 packets.
430.It Va always_keepalive
431Assume that
432.Dv SO_KEEPALIVE
433is set on all
434.Tn TCP
435connections, the kernel will
436periodically send a packet to the remote host to verify the connection
437is still up.
438.It Va icmp_may_rst
439Certain
440.Tn ICMP
441unreachable messages may abort connections in
442.Tn SYN-SENT
443state.
444.It Va do_tcpdrain
445Flush packets in the
446.Tn TCP
447reassembly queue if the system is low on mbufs.
448.It Va blackhole
449If enabled, disable sending of RST when a connection is attempted
450to a port where there is not a socket accepting connections.
451See
452.Xr blackhole 4 .
453.It Va delayed_ack
454Delay ACK to try and piggyback it onto a data packet.
455.It Va delacktime
456Maximum amount of time, in milliseconds, before a delayed ACK is sent.
457.It Va path_mtu_discovery
458Enable Path MTU Discovery.
459.It Va tcbhashsize
460Size of the
461.Tn TCP
462control-block hash table
463(read-only).
464This may be tuned using the kernel option
465.Dv TCBHASHSIZE
466or by setting
467.Va net.inet.tcp.tcbhashsize
468in the
469.Xr loader 8 .
470.It Va pcbcount
471Number of active process control blocks
472(read-only).
473.It Va syncookies
474Determines whether or not
475.Tn SYN
476cookies should be generated for outbound
477.Tn SYN-ACK
478packets.
479.Tn SYN
480cookies are a great help during
481.Tn SYN
482flood attacks, and are enabled by default.
483(See
484.Xr syncookies 4 . )
485.It Va isn_reseed_interval
486The interval (in seconds) specifying how often the secret data used in
487RFC 1948 initial sequence number calculations should be reseeded.
488By default, this variable is set to zero, indicating that
489no reseeding will occur.
490Reseeding should not be necessary, and will break
491.Dv TIME_WAIT
492recycling for a few minutes.
493.It Va reass.cursegments
494The current total number of segments present in all reassembly queues.
495.It Va reass.maxsegments
496The maximum limit on the total number of segments across all reassembly
497queues.
498The limit can be adjusted as a tunable.
499.It Va reass.maxqueuelen
500The maximum number of segments allowed in each reassembly queue.
501By default, the system chooses a limit based on each TCP connection's
502receive buffer size and maximum segment size (MSS).
503The actual limit applied to a session's reassembly queue will be the lower of
504the system-calculated automatic limit and the user-specified
505.Va reass.maxqueuelen
506limit.
507.It Va rexmit_initial , rexmit_min , rexmit_slop
508Adjust the retransmit timer calculation for
509.Tn TCP .
510The slop is
511typically added to the raw calculation to take into account
512occasional variances that the
513.Tn SRTT
514(smoothed round-trip time)
515is unable to accommodate, while the minimum specifies an
516absolute minimum.
517While a number of
518.Tn TCP
519RFCs suggest a 1
520second minimum, these RFCs tend to focus on streaming behavior,
521and fail to deal with the fact that a 1 second minimum has severe
522detrimental effects over lossy interactive connections, such
523as a 802.11b wireless link, and over very fast but lossy
524connections for those cases not covered by the fast retransmit
525code.
526For this reason, we use 200ms of slop and a near-0
527minimum, which gives us an effective minimum of 200ms (similar to
528.Tn Linux ) .
529The initial value is used before an RTT measurement has been performed.
530.It Va initcwnd_segments
531Enable the ability to specify initial congestion window in number of segments.
532The default value is 10 as suggested by RFC 6928.
533Changing the value on fly would not affect connections using congestion window
534from the hostcache.
535Caution:
536This regulates the burst of packets allowed to be sent in the first RTT.
537The value should be relative to the link capacity.
538Start with small values for lower-capacity links.
539Large bursts can cause buffer overruns and packet drops if routers have small
540buffers or the link is experiencing congestion.
541.It Va newcwd
542Enable the New Congestion Window Validation mechanism as described in RFC 7661.
543This gently reduces the congestion window during periods, where TCP is
544application limited and the network bandwidth is not utilized completely.
545That prevents self-inflicted packet losses once the application starts to
546transmit data at a higher speed.
547.It Va do_prr
548Perform SACK loss recovery using the Proportional Rate Reduction (PRR) algorithm
549described in RFC6937.
550This improves the effectiveness of retransmissions particular in environments
551with ACK thinning or burst loss events, as chances to run out of the ACK clock
552are reduced, preventing lengthy and performance reducing RTO based loss recovery
553(default is true).
554.It Va do_prr_conservative
555While doing Proportional Rate Reduction, remain strictly in a packet conserving
556mode, sending only one new packet for each ACK received.
557Helpful when a misconfigured token bucket traffic policer causes persistent
558high losses leading to RTO, but reduces PRR effectiveness in more common settings
559(default is false).
560.It Va rfc6675_pipe
561Calculate the bytes in flight using the algorithm described in RFC 6675, and
562is also an improvement when Proportional Rate Reduction is enabled.
563Also enables two other mechanisms from RFC6675.
564Rescue Retransmission helps timely loss recovery, when the trailing segments
565of a transmission are lost, while no additional data is ready to be sent.
566In case a partial ACK without a SACK block is received during SACK loss
567recovery, the trailing segment is immediately resent, rather than waiting
568for a Retransmission timeout.
569SACK loss recovery is also engaged, once two segments plus one byte are
570SACKed - even if no traditional duplicate ACKs were seen.
571.It Va rfc3042
572Enable the Limited Transmit algorithm as described in RFC 3042.
573It helps avoid timeouts on lossy links and also when the congestion window
574is small, as happens on short transfers.
575.It Va rfc3390
576Enable support for RFC 3390, which allows for a variable-sized
577starting congestion window on new connections, depending on the
578maximum segment size.
579This helps throughput in general, but
580particularly affects short transfers and high-bandwidth large
581propagation-delay connections.
582.It Va sack.enable
583Enable support for RFC 2018, TCP Selective Acknowledgment option,
584which allows the receiver to inform the sender about all successfully
585arrived segments, allowing the sender to retransmit the missing segments
586only.
587.It Va sack.maxholes
588Maximum number of SACK holes per connection.
589Defaults to 128.
590.It Va sack.globalmaxholes
591Maximum number of SACK holes per system, across all connections.
592Defaults to 65536.
593.It Va maxtcptw
594When a TCP connection enters the
595.Dv TIME_WAIT
596state, its associated socket structure is freed, since it is of
597negligible size and use, and a new structure is allocated to contain a
598minimal amount of information necessary for sustaining a connection in
599this state, called the compressed TCP TIME_WAIT state.
600Since this structure is smaller than a socket structure, it can save
601a significant amount of system memory.
602The
603.Va net.inet.tcp.maxtcptw
604MIB variable controls the maximum number of these structures allocated.
605By default, it is initialized to
606.Va kern.ipc.maxsockets
607/ 5.
608.It Va nolocaltimewait
609Suppress creating of compressed TCP TIME_WAIT states for connections in
610which both endpoints are local.
611.It Va fast_finwait2_recycle
612Recycle
613.Tn TCP
614.Dv FIN_WAIT_2
615connections faster when the socket is marked as
616.Dv SBS_CANTRCVMORE
617(no user process has the socket open, data received on
618the socket cannot be read).
619The timeout used here is
620.Va finwait2_timeout .
621.It Va finwait2_timeout
622Timeout to use for fast recycling of
623.Tn TCP
624.Dv FIN_WAIT_2
625connections.
626Defaults to 60 seconds.
627.It Va ecn.enable
628Enable support for TCP Explicit Congestion Notification (ECN).
629ECN allows a TCP sender to reduce the transmission rate in order to
630avoid packet drops.
631.Bl -tag -compact
632.It 0
633Disable ECN.
634.It 1
635Allow incoming connections to request ECN.
636Outgoing connections will request ECN.
637.It 2
638Allow incoming connections to request ECN.
639Outgoing connections will not request ECN.
640(default)
641.El
642.It Va ecn.maxretries
643Number of retries (SYN or SYN/ACK retransmits) before disabling ECN on a
644specific connection.
645This is needed to help with connection establishment
646when a broken firewall is in the network path.
647.It Va pmtud_blackhole_detection
648Enable automatic path MTU blackhole detection.
649In case of retransmits of MSS sized segments,
650the OS will lower the MSS to check if it's an MTU problem.
651If the current MSS is greater than the configured value to try
652.Po Va net.inet.tcp.pmtud_blackhole_mss
653and
654.Va net.inet.tcp.v6pmtud_blackhole_mss
655.Pc ,
656it will be set to this value, otherwise,
657the MSS will be set to the default values
658.Po Va net.inet.tcp.mssdflt
659and
660.Va net.inet.tcp.v6mssdflt
661.Pc .
662Settings:
663.Bl -tag -compact
664.It 0
665Disable path MTU blackhole detection.
666.It 1
667Enable path MTU blackhole detection for IPv4 and IPv6.
668.It 2
669Enable path MTU blackhole detection only for IPv4.
670.It 3
671Enable path MTU blackhole detection only for IPv6.
672.El
673.It Va pmtud_blackhole_mss
674MSS to try for IPv4 if PMTU blackhole detection is turned on.
675.It Va v6pmtud_blackhole_mss
676MSS to try for IPv6 if PMTU blackhole detection is turned on.
677.It Va hostcache.enable
678The TCP host cache is used to cache connection details and metrics to
679improve future performance of connections between the same hosts.
680At the completion of a TCP connection, a host will cache information
681for the connection for some defined period of time.
682.Bl -tag -compact
683.It 0
684Disable the host cache.
685.It 1
686Enable the host cache. (default)
687.It Va hostcache.purgenow
688Immediately purge all entries once set to any value.
689Setting this to 2 will also reseed the hash salt.
690.It Va hostcache.purge
691Expire all entires on next pruning of host cache entries.
692Any non-zero setting will be reset to zero, once the pruge
693is running.
694.Bl -tag -compact
695.It 0
696Do not purge all entries when pruning the host cache. (default)
697.It 1
698Purge all entries when doing the next pruning.
699.It 2
700Purge all entries, and also reseed the hash salt.
701.It Va hostcache.prune
702Time in seconds between pruning expired host cache entries.
703Defaults to 300 (5 minutes).
704.It Va hostcache.expire
705Time in seconds, how long a entry should be kept in the
706host cache since last accessed.
707Defaults to 3600 (1 hour).
708.It Va hostcache.count
709The current number of entries in the host cache.
710.It Va hostcache.bucketlimit
711The maximum number of entries for the same hash.
712Defaults to 30.
713.It Va hostcache.hashsize
714Size of TCP hostcache hashtable.
715This number has to be a power of two, or will be rejected.
716Defaults to 512.
717.It Va hostcache.cachelimit
718Overall entry limit for hostcache.
719Defaults to hashsize * bucketlimit.
720.It Va hostcache.histo
721Provide a Histogram of the hostcache hash utilization.
722.It Va hostcache.list
723Provide a complete list of all current entries in the host
724cache.
725.It Va functions_available
726List of available TCP function blocks (TCP stacks).
727.It Va functions_default
728The default TCP function block (TCP stack).
729.It Va functions_inherit_listen_socket_stack
730Determines whether to inherit listen socket's tcp stack or use the current
731system default tcp stack, as defined by
732.Va functions_default .
733Default is true.
734.It Va insecure_rst
735Use criteria defined in RFC793 instead of RFC5961 for accepting RST segments.
736Default is false.
737.It Va insecure_syn
738Use criteria defined in RFC793 instead of RFC5961 for accepting SYN segments.
739Default is false.
740.It Va ts_offset_per_conn
741When initializing the TCP timestamps, use a per connection offset instead of a
742per host pair offset.
743Default is to use per connection offsets as recommended in RFC 7323.
744.It Va perconn_stats_enable
745Controls the default collection of statistics for all connections using the
746.Xr stats 3
747framework.
7480 disables, 1 enables, 2 enables random sampling across log id connection
749groups with all connections in a group receiving the same setting.
750.It Va perconn_stats_sample_rates
751A CSV list of template_spec=percent key-value pairs which controls the per
752template sampling rates when
753.Xr stats 3
754sampling is enabled.
755.El
756.Sh ERRORS
757A socket operation may fail with one of the following errors returned:
758.Bl -tag -width Er
759.It Bq Er EISCONN
760when trying to establish a connection on a socket which
761already has one;
762.It Bo Er ENOBUFS Bc or Bo Er ENOMEM Bc
763when the system runs out of memory for
764an internal data structure;
765.It Bq Er ETIMEDOUT
766when a connection was dropped
767due to excessive retransmissions;
768.It Bq Er ECONNRESET
769when the remote peer
770forces the connection to be closed;
771.It Bq Er ECONNREFUSED
772when the remote
773peer actively refuses connection establishment (usually because
774no process is listening to the port);
775.It Bq Er EADDRINUSE
776when an attempt
777is made to create a socket with a port which has already been
778allocated;
779.It Bq Er EADDRNOTAVAIL
780when an attempt is made to create a
781socket with a network address for which no network interface
782exists;
783.It Bq Er EAFNOSUPPORT
784when an attempt is made to bind or connect a socket to a multicast
785address.
786.It Bq Er EINVAL
787when trying to change TCP function blocks at an invalid point in the session;
788.It Bq Er ENOENT
789when trying to use a TCP function block that is not available;
790.El
791.Sh SEE ALSO
792.Xr getsockopt 2 ,
793.Xr socket 2 ,
794.Xr stats 3 ,
795.Xr sysctl 3 ,
796.Xr blackhole 4 ,
797.Xr inet 4 ,
798.Xr intro 4 ,
799.Xr ip 4 ,
800.Xr ktls 4 ,
801.Xr mod_cc 4 ,
802.Xr siftr 4 ,
803.Xr syncache 4 ,
804.Xr tcp_bbr 4 ,
805.Xr setkey 8 ,
806.Xr tcp_functions 9
807.Rs
808.%A "V. Jacobson"
809.%A "B. Braden"
810.%A "D. Borman"
811.%T "TCP Extensions for High Performance"
812.%O "RFC 1323"
813.Re
814.Rs
815.%A "D. Borman"
816.%A "B. Braden"
817.%A "V. Jacobson"
818.%A "R. Scheffenegger"
819.%T "TCP Extensions for High Performance"
820.%O "RFC 7323"
821.Re
822.Rs
823.%A "A. Heffernan"
824.%T "Protection of BGP Sessions via the TCP MD5 Signature Option"
825.%O "RFC 2385"
826.Re
827.Rs
828.%A "K. Ramakrishnan"
829.%A "S. Floyd"
830.%A "D. Black"
831.%T "The Addition of Explicit Congestion Notification (ECN) to IP"
832.%O "RFC 3168"
833.Re
834.Sh HISTORY
835The
836.Tn TCP
837protocol appeared in
838.Bx 4.2 .
839The RFC 1323 extensions for window scaling and timestamps were added
840in
841.Bx 4.4 .
842The
843.Dv TCP_INFO
844option was introduced in
845.Tn Linux 2.6
846and is
847.Em subject to change .
848