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
 92_ctf_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,
 95    uint32_t *ts, uint32_t *cnt);
 96void ctf_ack_war_checks(struct tcpcb *tp, uint32_t *ts, uint32_t *cnt);
 97#define ctf_drop_checks(a, b, c, d, e, f, g, h) _ctf_drop_checks(a, b, c, d, e, f, g, h, NULL, NULL)
 98
 99void
100__ctf_do_dropafterack(struct mbuf *m, struct tcpcb *tp,
101      struct tcphdr *th, int32_t thflags, int32_t tlen,
102      int32_t *ret_val, uint32_t *ts, uint32_t *cnt);
103
104#define ctf_do_dropafterack(a, b, c, d, e, f) __ctf_do_dropafterack(a, b, c, d, e, f, NULL, NULL)
105
106void
107ctf_do_dropwithreset(struct mbuf *m, struct tcpcb *tp,
108	struct tcphdr *th, int32_t rstreason, int32_t tlen);
109void
110ctf_do_drop(struct mbuf *m, struct tcpcb *tp);
111
112int
113__ctf_process_rst(struct mbuf *m, struct tcphdr *th,
114      struct socket *so, struct tcpcb *tp, uint32_t *ts, uint32_t *cnt);
115#define ctf_process_rst(m, t, s, p) __ctf_process_rst(m, t, s, p, NULL, NULL)
116
117void
118ctf_challenge_ack(struct mbuf *m, struct tcphdr *th,
119    struct tcpcb *tp, uint8_t iptos, int32_t * ret_val);
120
121int
122ctf_ts_check(struct mbuf *m, struct tcphdr *th,
123    struct tcpcb *tp, int32_t tlen, int32_t thflags, int32_t * ret_val);
124
125int
126ctf_ts_check_ac(struct tcpcb *tp, int32_t thflags);
127
128void
129ctf_calc_rwin(struct socket *so, struct tcpcb *tp);
130
131void
132ctf_do_dropwithreset_conn(struct mbuf *m, struct tcpcb *tp, struct tcphdr *th,
133    int32_t rstreason, int32_t tlen);
134
135uint32_t
136ctf_fixed_maxseg(struct tcpcb *tp);
137
138void
139ctf_log_sack_filter(struct tcpcb *tp, int num_sack_blks, struct sackblk *sack_blocks);
140
141uint32_t
142ctf_decay_count(uint32_t count, uint32_t decay_percentage);
143
144int32_t
145ctf_progress_timeout_check(struct tcpcb *tp, bool log);
146
147#endif
148#endif