1#ifndef __rack_bbr_common_h__
2#define __rack_bbr_common_h__
3/*-
4 * Copyright (c) 2016-2020 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
28/* Common defines and such used by both RACK and BBR */
29/* Special values for mss accounting array */
30#define TCP_MSS_ACCT_JUSTRET 0
31#define TCP_MSS_ACCT_SNDACK 1
32#define TCP_MSS_ACCT_PERSIST 2
33#define TCP_MSS_ACCT_ATIMER 60
34#define TCP_MSS_ACCT_INPACE 61
35#define TCP_MSS_ACCT_LATE 62
36#define TCP_MSS_SMALL_SIZE_OFF 63 /* Point where small sizes enter */
37#define TCP_MSS_ACCT_SIZE 70
38#define TCP_MSS_SMALL_MAX_SIZE_DIV (TCP_MSS_ACCT_SIZE - TCP_MSS_SMALL_SIZE_OFF)
39
40#define DUP_ACK_THRESHOLD 3
41
42/* Magic flags for tracing progress events */
43#define PROGRESS_DROP 1
44#define PROGRESS_UPDATE 2
45#define PROGRESS_CLEAR 3
46#define PROGRESS_START 4
47
48/* codes for just-return */
49#define CTF_JR_SENT_DATA 0
50#define CTF_JR_CWND_LIMITED 1
51#define CTF_JR_RWND_LIMITED 2
52#define CTF_JR_APP_LIMITED 3
53#define CTF_JR_ASSESSING 4
54#define CTF_JR_PERSISTS 5
55#define CTF_JR_PRR 6
56
57/* Compat. */
58#define BBR_JR_SENT_DATA CTF_JR_SENT_DATA
59#define BBR_JR_CWND_LIMITED CTF_JR_CWND_LIMITED
60#define BBR_JR_RWND_LIMITED CTF_JR_RWND_LIMITED
61#define BBR_JR_APP_LIMITED CTF_JR_APP_LIMITED
62#define BBR_JR_ASSESSING CTF_JR_ASSESSING
63#define BBR_JR_PERSISTS CTF_JR_PERSISTS
64#define BBR_JR_PRR CTF_JR_PRR
65
66/* RTT sample methods */
67#define USE_RTT_HIGH 0
68#define USE_RTT_LOW 1
69#define USE_RTT_AVG 2
70
71#define PACE_MAX_IP_BYTES 65536
72#define USECS_IN_SECOND 1000000
73#define MSEC_IN_SECOND 1000
74#define MS_IN_USEC 1000
75#define USEC_TO_MSEC(x) (x / MS_IN_USEC)
76#define TCP_TS_OVERHEAD 12 /* Overhead of having Timestamps on */
77
78/* Bits per second in bytes per second */
79#define FORTY_EIGHT_MBPS 6000000 /* 48 megabits in bytes */
80#define THIRTY_MBPS 3750000 /* 30 megabits in bytes */
81#define TWENTY_THREE_MBPS 2896000 /* 23 megabits in bytes */
82#define FIVETWELVE_MBPS 64000000 /* 512 megabits in bytes */
83#define ONE_POINT_TWO_MEG 150000 /* 1.2 megabits in bytes */
84
85#ifdef _KERNEL
86/* We have only 7 bits in rack so assert its true */
87CTASSERT((PACE_TMR_MASK & 0x80) == 0);
88int ctf_do_queued_segments(struct tcpcb *tp, int have_pkt);
89uint32_t ctf_outstanding(struct tcpcb *tp);
90uint32_t ctf_flight_size(struct tcpcb *tp, uint32_t rc_sacked);
91int
92ctf_drop_checks(struct tcpopt *to, struct mbuf *m, struct tcphdr *th,
93 struct tcpcb *tp, int32_t *tlenp,
94 int32_t *thf, int32_t *drop_hdrlen, int32_t *ret_val);
95void ctf_ack_war_checks(struct tcpcb *tp);
96
97void
98ctf_do_dropafterack(struct mbuf *m, struct tcpcb *tp,
99 struct tcphdr *th, int32_t thflags, int32_t tlen,
100 int32_t *ret_val);
101
102void
103ctf_do_dropwithreset(struct mbuf *m, struct tcpcb *tp,
104 struct tcphdr *th, int32_t tlen);
105void
106ctf_do_drop(struct mbuf *m, struct tcpcb *tp);
107
108int
109ctf_process_rst(struct mbuf *m, struct tcphdr *th,
110 struct socket *so, struct tcpcb *tp);
111
112void
113ctf_challenge_ack(struct mbuf *m, struct tcphdr *th,
114 struct tcpcb *tp, uint8_t iptos, int32_t * ret_val);
115
116int
117ctf_ts_check(struct mbuf *m, struct tcphdr *th,
118 struct tcpcb *tp, int32_t tlen, int32_t thflags, int32_t * ret_val);
119
120int
121ctf_ts_check_ac(struct tcpcb *tp, int32_t thflags);
122
123void
124ctf_calc_rwin(struct socket *so, struct tcpcb *tp);
125
126void
127ctf_do_dropwithreset_conn(struct mbuf *m, struct tcpcb *tp, struct tcphdr *th,
128 int32_t tlen);
129
130uint32_t
131ctf_fixed_maxseg(struct tcpcb *tp);
132
133void
134ctf_log_sack_filter(struct tcpcb *tp, int num_sack_blks, struct sackblk *sack_blocks);
135
136uint32_t
137ctf_decay_count(uint32_t count, uint32_t decay_percentage);
138
139int32_t
140ctf_progress_timeout_check(struct tcpcb *tp, bool log);
141
142#endif
143#endif