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