xref: /xnu-11215.81.4/bsd/netinet/tcp_cache.h (revision d4514f0bc1d3f944c22d92e68b646ac3fb40d452)
1*d4514f0bSApple OSS Distributions /*
2*d4514f0bSApple OSS Distributions  * Copyright (c) 2015-2024 Apple Inc. All rights reserved.
3*d4514f0bSApple OSS Distributions  *
4*d4514f0bSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*d4514f0bSApple OSS Distributions  *
6*d4514f0bSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*d4514f0bSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*d4514f0bSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*d4514f0bSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*d4514f0bSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*d4514f0bSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*d4514f0bSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*d4514f0bSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*d4514f0bSApple OSS Distributions  *
15*d4514f0bSApple OSS Distributions  * Please obtain a copy of the License at
16*d4514f0bSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*d4514f0bSApple OSS Distributions  *
18*d4514f0bSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*d4514f0bSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*d4514f0bSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*d4514f0bSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*d4514f0bSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*d4514f0bSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*d4514f0bSApple OSS Distributions  * limitations under the License.
25*d4514f0bSApple OSS Distributions  *
26*d4514f0bSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*d4514f0bSApple OSS Distributions  */
28*d4514f0bSApple OSS Distributions 
29*d4514f0bSApple OSS Distributions /* TCP-cache to store and retrieve TCP-related information */
30*d4514f0bSApple OSS Distributions 
31*d4514f0bSApple OSS Distributions #ifndef _NETINET_TCP_CACHE_H
32*d4514f0bSApple OSS Distributions #define _NETINET_TCP_CACHE_H
33*d4514f0bSApple OSS Distributions 
34*d4514f0bSApple OSS Distributions #include <netinet/tcp_var.h>
35*d4514f0bSApple OSS Distributions #include <netinet/in.h>
36*d4514f0bSApple OSS Distributions 
37*d4514f0bSApple OSS Distributions #define ECN_MIN_CE_PROBES       10 /* Probes are basically the number of incoming packets */
38*d4514f0bSApple OSS Distributions #define ECN_MAX_CE_RATIO        7 /* Ratio is the maximum number of CE-packets we accept per incoming "probe" */
39*d4514f0bSApple OSS Distributions 
40*d4514f0bSApple OSS Distributions extern void tcp_cache_set_cookie(struct tcpcb *tp, u_char *__counted_by(len) cookie, u_int8_t len);
41*d4514f0bSApple OSS Distributions extern int tcp_cache_get_cookie(struct tcpcb *tp, u_char *__counted_by(buflen) cookie, uint8_t buflen, u_int8_t *len);
42*d4514f0bSApple OSS Distributions extern unsigned int tcp_cache_get_cookie_len(struct tcpcb *tp);
43*d4514f0bSApple OSS Distributions extern uint8_t tcp_cache_get_mptcp_version(struct sockaddr* dst);
44*d4514f0bSApple OSS Distributions extern void tcp_cache_update_mptcp_version(struct tcpcb *tp, boolean_t succeeded);
45*d4514f0bSApple OSS Distributions 
46*d4514f0bSApple OSS Distributions extern void tcp_heuristic_tfo_loss(struct tcpcb *tp);
47*d4514f0bSApple OSS Distributions extern void tcp_heuristic_tfo_rst(struct tcpcb *tp);
48*d4514f0bSApple OSS Distributions extern void tcp_heuristic_mptcp_loss(struct tcpcb *tp);
49*d4514f0bSApple OSS Distributions extern void tcp_heuristic_ecn_loss(struct tcpcb *tp);
50*d4514f0bSApple OSS Distributions extern void tcp_heuristic_tfo_middlebox(struct tcpcb *tp);
51*d4514f0bSApple OSS Distributions extern void tcp_heuristic_ecn_aggressive(struct tcpcb *tp);
52*d4514f0bSApple OSS Distributions extern void tcp_heuristic_tfo_success(struct tcpcb *tp);
53*d4514f0bSApple OSS Distributions extern void tcp_heuristic_mptcp_success(struct tcpcb *tp);
54*d4514f0bSApple OSS Distributions extern void tcp_heuristic_ecn_success(struct tcpcb *tp);
55*d4514f0bSApple OSS Distributions extern boolean_t tcp_heuristic_do_tfo(struct tcpcb *tp);
56*d4514f0bSApple OSS Distributions extern int tcp_heuristic_do_mptcp(struct tcpcb *tp);
57*d4514f0bSApple OSS Distributions extern boolean_t tcp_heuristic_do_ecn(struct tcpcb *tp);
58*d4514f0bSApple OSS Distributions extern void tcp_heuristic_ecn_droprst(struct tcpcb *tp);
59*d4514f0bSApple OSS Distributions extern void tcp_heuristic_ecn_droprxmt(struct tcpcb *tp);
60*d4514f0bSApple OSS Distributions extern void tcp_heuristic_ecn_synrst(struct tcpcb *tp);
61*d4514f0bSApple OSS Distributions 
62*d4514f0bSApple OSS Distributions extern boolean_t tcp_heuristic_do_ecn_with_address(struct ifnet *ifp,
63*d4514f0bSApple OSS Distributions     union sockaddr_in_4_6 *local_address);
64*d4514f0bSApple OSS Distributions extern void tcp_heuristics_ecn_update(struct necp_tcp_ecn_cache *necp_buffer,
65*d4514f0bSApple OSS Distributions     struct ifnet *ifp, union sockaddr_in_4_6 *local_address);
66*d4514f0bSApple OSS Distributions extern boolean_t tcp_heuristic_do_tfo_with_address(struct ifnet *ifp,
67*d4514f0bSApple OSS Distributions     union sockaddr_in_4_6 *local_address, union sockaddr_in_4_6 *remote_address,
68*d4514f0bSApple OSS Distributions     u_int8_t *__counted_by(maxlen) cookie, u_int8_t maxlen, u_int8_t *cookie_len);
69*d4514f0bSApple OSS Distributions extern void tcp_heuristics_tfo_update(struct necp_tcp_tfo_cache *necp_buffer,
70*d4514f0bSApple OSS Distributions     struct ifnet *ifp, union sockaddr_in_4_6 *local_address,
71*d4514f0bSApple OSS Distributions     union sockaddr_in_4_6 *remote_address);
72*d4514f0bSApple OSS Distributions 
73*d4514f0bSApple OSS Distributions extern void tcp_cache_init(void);
74*d4514f0bSApple OSS Distributions 
75*d4514f0bSApple OSS Distributions #endif /* _NETINET_TCP_CACHE_H */
76