sys/netinet/tcp_timer.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)tcp_timer.h 8.1 (Berkeley) 6/10/93
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _NETINET_TCP_TIMER_H_
  36 #define _NETINET_TCP_TIMER_H_
  37
  38 #define TCPT_REXMT      0               /* retransmit */
  39 #define TCPT_PERSIST    1               /* retransmit persistance */
  40 #define TCPT_KEEP       2               /* keep alive */
  41 #define TCPT_2MSL       3               /* 2*msl quiet time timer */
  42 #define TCPT_DELACK     4               /* delay ack */
  43
  44 /*
  45  * The TCPT_REXMT timer is used to force retransmissions.
  46  * The TCP has the TCPT_REXMT timer set whenever segments
  47  * have been sent for which ACKs are expected but not yet
  48  * received.  If an ACK is received which advances tp->snd_una,
  49  * then the retransmit timer is cleared (if there are no more
  50  * outstanding segments) or reset to the base value (if there
  51  * are more ACKs expected).  Whenever the retransmit timer goes off,
  52  * we retransmit one unacknowledged segment, and do a backoff
  53  * on the retransmit timer.
  54  *
  55  * The TCPT_PERSIST timer is used to keep window size information
  56  * flowing even if the window goes shut.  If all previous transmissions
  57  * have been acknowledged (so that there are no retransmissions in progress),
  58  * and the window is too small to bother sending anything, then we start
  59  * the TCPT_PERSIST timer.  When it expires, if the window is nonzero,
  60  * we go to transmit state.  Otherwise, at intervals send a single byte
  61  * into the peer's window to force him to update our window information.
  62  * We do this at most as often as TCPT_PERSMIN time intervals,
  63  * but no more frequently than the current estimate of round-trip
  64  * packet time.  The TCPT_PERSIST timer is cleared whenever we receive
  65  * a window update from the peer.
  66  *
  67  * The TCPT_KEEP timer is used to keep connections alive.  If an
  68  * connection is idle (no segments received) for TCPTV_KEEP_INIT amount of time,
  69  * but not yet established, then we drop the connection.  Once the connection
  70  * is established, if the connection is idle for TCPTV_KEEP_IDLE time
  71  * (and keepalives have been enabled on the socket), we begin to probe
  72  * the connection.  We force the peer to send us a segment by sending:
  73  *      <SEQ=SND.UNA-1><ACK=RCV.NXT><CTL=ACK>
  74  * This segment is (deliberately) outside the window, and should elicit
  75  * an ack segment in response from the peer.  If, despite the TCPT_KEEP
  76  * initiated segments we cannot elicit a response from a peer in TCPT_MAXIDLE
  77  * amount of time probing, then we drop the connection.
  78  */
  79
  80 /*
  81  * Time constants.
  82  */
  83 #define TCPTV_MSL       ( 30*hz)                /* max seg lifetime (hah!) */
  84 #define TCPTV_SRTTBASE  0                       /* base roundtrip time;
  85                                                    if 0, no idea yet */
  86 #define TCPTV_RTOBASE   (  1*hz)                /* assumed RTO if no info */
  87
  88 #define TCPTV_PERSMIN   (  5*hz)                /* minimum persist interval */
  89 #define TCPTV_PERSMAX   ( 60*hz)                /* maximum persist interval */
  90
  91 #define TCPTV_KEEP_INIT ( 75*hz)                /* initial connect keepalive */
  92 #define TCPTV_KEEP_IDLE (120*60*hz)             /* dflt time before probing */
  93 #define TCPTV_KEEPINTVL ( 75*hz)                /* default probe interval */
  94 #define TCPTV_KEEPCNT   8                       /* max probes before drop */
  95
  96 #define TCPTV_FINWAIT2_TIMEOUT (60*hz)         /* FIN_WAIT_2 timeout if no receiver */
  97
  98 /*
  99  * Minimum retransmit timer is 3 ticks, for algorithmic stability.
 100  * TCPT_RANGESET() will add another TCPTV_CPU_VAR to deal with
 101  * the expected worst-case processing variances by the kernels
 102  * representing the end points.  Such variances do not always show
 103  * up in the srtt because the timestamp is often calculated at
 104  * the interface rather then at the TCP layer.  This value is
 105  * typically 50ms.  However, it is also possible that delayed
 106  * acks (typically 100ms) could create issues so we set the slop
 107  * to 200ms to try to cover it.  Note that, properly speaking,
 108  * delayed-acks should not create a major issue for interactive
 109  * environments which 'P'ush the last segment, at least as
 110  * long as implementations do the required 'at least one ack
 111  * for every two packets' for the non-interactive streaming case.
 112  * (maybe the RTO calculation should use 2*RTT instead of RTT
 113  * to handle the ack-every-other-packet case).
 114  *
 115  * The prior minimum of 1*hz (1 second) badly breaks throughput on any
 116  * networks faster then a modem that has minor (e.g. 1%) packet loss.
 117  */
 118 #define TCPTV_MIN       ( hz/33 )               /* minimum allowable value */
 119 #define TCPTV_CPU_VAR   ( hz/5 )                /* cpu variance allowed (200ms) */
 120 #define TCPTV_REXMTMAX  ( 64*hz)                /* max allowable REXMT value */
 121
 122 #define TCPTV_TWTRUNC   8                       /* RTO factor to truncate TW */
 123
 124 #define TCP_MAXRXTSHIFT 12                      /* maximum retransmits */
 125
 126 #define TCPTV_DELACK    ( hz/25 )               /* 40ms timeout */
 127
 128 /*
 129  * If we exceed this number of retransmits for a single segment, we'll consider
 130  * the current srtt measurement no longer valid and will recalculate from
 131  * scratch starting with the next ACK.
 132  */
 133 #define TCP_RTT_INVALIDATE (TCP_MAXRXTSHIFT / 4)
 134
 135 #ifdef  TCPTIMERS
 136 static const char *tcptimers[] =
 137     { "REXMT", "PERSIST", "KEEP", "2MSL", "DELACK" };
 138 #endif
 139
 140 /*
 141  * Force a time value to be in a certain range.
 142  */
 143 #define TCPT_RANGESET(tv, value, tvmin, tvmax) do { \
 144         (tv) = (value) + tcp_rexmit_slop; \
 145         if ((u_long)(tv) < (u_long)(tvmin)) \
 146                 (tv) = (tvmin); \
 147         if ((u_long)(tv) > (u_long)(tvmax)) \
 148                 (tv) = (tvmax); \
 149 } while(0)
 150
 151 #ifdef _KERNEL
 152
 153 struct xtcp_timer;
 154
 155 struct tcp_timer {
 156         struct  callout tt_rexmt;       /* retransmit timer */
 157         struct  callout tt_persist;     /* retransmit persistence */
 158         struct  callout tt_keep;        /* keepalive */
 159         struct  callout tt_2msl;        /* 2*msl TIME_WAIT timer */
 160         struct  callout tt_delack;      /* delayed ACK timer */
 161         uint32_t        tt_flags;       /* Timers flags */
 162         uint32_t        tt_draincnt;    /* Count being drained */
 163 };
 164
 165 /*
 166  * Flags for the tt_flags field.
 167  */
 168 #define TT_DELACK       0x0001
 169 #define TT_REXMT        0x0002
 170 #define TT_PERSIST      0x0004
 171 #define TT_KEEP         0x0008
 172 #define TT_2MSL         0x0010
 173 #define TT_MASK         (TT_DELACK|TT_REXMT|TT_PERSIST|TT_KEEP|TT_2MSL)
 174
 175 /*
 176  * Suspend flags - used when suspending a timer
 177  * from ever running again.
 178  */
 179 #define TT_DELACK_SUS   0x0100
 180 #define TT_REXMT_SUS    0x0200
 181 #define TT_PERSIST_SUS  0x0400
 182 #define TT_KEEP_SUS     0x0800
 183 #define TT_2MSL_SUS     0x1000
 184
 185 #define TT_STOPPED      0x00010000
 186
 187 #define TP_KEEPINIT(tp) ((tp)->t_keepinit ? (tp)->t_keepinit : tcp_keepinit)
 188 #define TP_KEEPIDLE(tp) ((tp)->t_keepidle ? (tp)->t_keepidle : tcp_keepidle)
 189 #define TP_KEEPINTVL(tp) ((tp)->t_keepintvl ? (tp)->t_keepintvl : tcp_keepintvl)
 190 #define TP_KEEPCNT(tp)  ((tp)->t_keepcnt ? (tp)->t_keepcnt : tcp_keepcnt)
 191 #define TP_MAXIDLE(tp)  (TP_KEEPCNT(tp) * TP_KEEPINTVL(tp))
 192
 193 extern int tcp_persmin;                 /* minimum persist interval */
 194 extern int tcp_persmax;                 /* maximum persist interval */
 195 extern int tcp_keepinit;                /* time to establish connection */
 196 extern int tcp_keepidle;                /* time before keepalive probes begin */
 197 extern int tcp_keepintvl;               /* time between keepalive probes */
 198 extern int tcp_keepcnt;                 /* number of keepalives */
 199 extern int tcp_delacktime;              /* time before sending a delayed ACK */
 200 extern int tcp_maxpersistidle;
 201 extern int tcp_rexmit_initial;
 202 extern int tcp_rexmit_min;
 203 extern int tcp_rexmit_slop;
 204 extern int tcp_ttl;                     /* time to live for TCP segs */
 205 extern int tcp_backoff[];
 206 extern int tcp_totbackoff;
 207 extern int tcp_rexmit_drop_options;
 208
 209 extern int tcp_finwait2_timeout;
 210 extern int tcp_fast_finwait2_recycle;
 211
 212 VNET_DECLARE(int, tcp_always_keepalive);
 213 #define V_tcp_always_keepalive          VNET(tcp_always_keepalive)
 214 VNET_DECLARE(int, tcp_pmtud_blackhole_detect);
 215 #define V_tcp_pmtud_blackhole_detect    VNET(tcp_pmtud_blackhole_detect)
 216 VNET_DECLARE(int, tcp_pmtud_blackhole_mss);
 217 #define V_tcp_pmtud_blackhole_mss       VNET(tcp_pmtud_blackhole_mss)
 218 VNET_DECLARE(int, tcp_v6pmtud_blackhole_mss);
 219 #define V_tcp_v6pmtud_blackhole_mss     VNET(tcp_v6pmtud_blackhole_mss)
 220 VNET_DECLARE(int, tcp_msl);
 221 #define V_tcp_msl                       VNET(tcp_msl)
 222
 223 void tcp_inpinfo_lock_del(struct inpcb *inp, struct tcpcb *tp);
 224
 225 void    tcp_timer_init(void);
 226 void    tcp_timer_2msl(void *xtp);
 227 void    tcp_timer_discard(void *);
 228 struct tcptw *
 229         tcp_tw_2msl_scan(int reuse);    /* XXX temporary? */
 230 void    tcp_timer_keep(void *xtp);
 231 void    tcp_timer_persist(void *xtp);
 232 void    tcp_timer_rexmt(void *xtp);
 233 void    tcp_timer_delack(void *xtp);
 234
 235 #endif /* _KERNEL */
 236
 237 #endif /* !_NETINET_TCP_TIMER_H_ */