xref: /freebsd/sys/netinet/tcp_stacks/rack_bbr_common.h (revision f6a3b357e9be4c6423c85eff9a847163a0d307c8)
1 #ifndef __pacer_timer_h__
2 #define __pacer_timer_h__
3 /*-
4  * Copyright (c) 2017 Netflix, Inc.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * __FBSDID("$FreeBSD$");
28  */
29 /* Common defines and such used by both RACK and BBR */
30 /* Special values for mss accounting array */
31 #define TCP_MSS_ACCT_JUSTRET 0
32 #define TCP_MSS_ACCT_SNDACK  1
33 #define TCP_MSS_ACCT_PERSIST 2
34 #define TCP_MSS_ACCT_ATIMER  60
35 #define TCP_MSS_ACCT_INPACE  61
36 #define TCP_MSS_ACCT_LATE    62
37 #define TCP_MSS_SMALL_SIZE_OFF 63	/* Point where small sizes enter */
38 #define TCP_MSS_ACCT_SIZE    70
39 #define TCP_MSS_SMALL_MAX_SIZE_DIV (TCP_MSS_ACCT_SIZE - TCP_MSS_SMALL_SIZE_OFF)
40 
41 #define DUP_ACK_THRESHOLD 3
42 
43 /* Magic flags for tracing progress events */
44 #define PROGRESS_DROP   1
45 #define PROGRESS_UPDATE 2
46 #define PROGRESS_CLEAR  3
47 #define PROGRESS_START  4
48 
49 
50 /* RTT sample methods */
51 #define USE_RTT_HIGH 0
52 #define USE_RTT_LOW  1
53 #define USE_RTT_AVG  2
54 
55 #define PACE_MAX_IP_BYTES 65536
56 #define USECS_IN_SECOND 1000000
57 #define MSEC_IN_SECOND 1000
58 #define MS_IN_USEC 1000
59 #define USEC_TO_MSEC(x) (x / MS_IN_USEC)
60 #define TCP_TS_OVERHEAD 12		/* Overhead of having Timestamps on */
61 
62 #ifdef _KERNEL
63 /* We have only 7 bits in rack so assert its true */
64 CTASSERT((PACE_TMR_MASK & 0x80) == 0);
65 #ifdef KERN_TLS
66 uint32_t ctf_get_opt_tls_size(struct socket *so, uint32_t rwnd);
67 #endif
68 int
69 ctf_process_inbound_raw(struct tcpcb *tp, struct socket *so,
70     struct mbuf *m, int has_pkt);
71 int
72 ctf_do_queued_segments(struct socket *so, struct tcpcb *tp, int have_pkt);
73 uint32_t ctf_outstanding(struct tcpcb *tp);
74 uint32_t ctf_flight_size(struct tcpcb *tp, uint32_t rc_sacked);
75 int
76 ctf_drop_checks(struct tcpopt *to, struct mbuf *m,
77     struct tcphdr *th, struct tcpcb *tp, int32_t * tlenp, int32_t * thf,
78     int32_t * drop_hdrlen, int32_t * ret_val);
79 void
80 ctf_do_dropafterack(struct mbuf *m, struct tcpcb *tp,
81     struct tcphdr *th, int32_t thflags, int32_t tlen, int32_t * ret_val);
82 void
83 ctf_do_dropwithreset(struct mbuf *m, struct tcpcb *tp,
84 	struct tcphdr *th, int32_t rstreason, int32_t tlen);
85 void
86 ctf_do_drop(struct mbuf *m, struct tcpcb *tp);
87 
88 int
89 ctf_process_rst(struct mbuf *m, struct tcphdr *th,
90     struct socket *so, struct tcpcb *tp);
91 
92 void
93 ctf_challenge_ack(struct mbuf *m, struct tcphdr *th,
94     struct tcpcb *tp, int32_t * ret_val);
95 
96 int
97 ctf_ts_check(struct mbuf *m, struct tcphdr *th,
98     struct tcpcb *tp, int32_t tlen, int32_t thflags, int32_t * ret_val);
99 
100 void
101 ctf_calc_rwin(struct socket *so, struct tcpcb *tp);
102 
103 void
104 ctf_do_dropwithreset_conn(struct mbuf *m, struct tcpcb *tp, struct tcphdr *th,
105     int32_t rstreason, int32_t tlen);
106 
107 uint32_t
108 ctf_fixed_maxseg(struct tcpcb *tp);
109 
110 void
111 ctf_log_sack_filter(struct tcpcb *tp, int num_sack_blks, struct sackblk *sack_blocks);
112 
113 uint32_t
114 ctf_decay_count(uint32_t count, uint32_t decay_percentage);
115 
116 #endif
117 #endif
118