sys/netinet/tcp_stacks/rack_bbr_common.h

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