sys/netinet/tcp_timer.h

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