bsd/netinet/tcp_timer.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1982, 1986, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *      @(#)tcp_timer.h 8.1 (Berkeley) 6/10/93
  55  * $FreeBSD: src/sys/netinet/tcp_timer.h,v 1.18 1999/12/29 04:41:03 peter Exp $
  56  */
  57
  58 #ifndef _NETINET_TCP_TIMER_H_
  59 #define _NETINET_TCP_TIMER_H_
  60 #include <sys/appleapiopts.h>
  61
  62 /*
  63  * Definitions of the TCP timers.  These timers are counted
  64  * down PR_SLOWHZ times a second.
  65  */
  66 #define TCPT_NTIMERS    4
  67
  68 #define TCPT_REXMT      0               /* retransmit */
  69 #define TCPT_PERSIST    1               /* retransmit persistence */
  70 #define TCPT_KEEP       2               /* keep alive */
  71 #define TCPT_2MSL       3               /* 2*msl quiet time timer */
  72
  73 /*
  74  * The TCPT_REXMT timer is used to force retransmissions.
  75  * The TCP has the TCPT_REXMT timer set whenever segments
  76  * have been sent for which ACKs are expected but not yet
  77  * received.  If an ACK is received which advances tp->snd_una,
  78  * then the retransmit timer is cleared (if there are no more
  79  * outstanding segments) or reset to the base value (if there
  80  * are more ACKs expected).  Whenever the retransmit timer goes off,
  81  * we retransmit one unacknowledged segment, and do a backoff
  82  * on the retransmit timer.
  83  *
  84  * The TCPT_PERSIST timer is used to keep window size information
  85  * flowing even if the window goes shut.  If all previous transmissions
  86  * have been acknowledged (so that there are no retransmissions in progress),
  87  * and the window is too small to bother sending anything, then we start
  88  * the TCPT_PERSIST timer.  When it expires, if the window is nonzero,
  89  * we go to transmit state.  Otherwise, at intervals send a single byte
  90  * into the peer's window to force him to update our window information.
  91  * We do this at most as often as TCPT_PERSMIN time intervals,
  92  * but no more frequently than the current estimate of round-trip
  93  * packet time.  The TCPT_PERSIST timer is cleared whenever we receive
  94  * a window update from the peer.
  95  *
  96  * The TCPT_KEEP timer is used to keep connections alive.  If an
  97  * connection is idle (no segments received) for TCPTV_KEEP_INIT amount of time,
  98  * but not yet established, then we drop the connection.  Once the connection
  99  * is established, if the connection is idle for TCPTV_KEEP_IDLE time
 100  * (and keepalives have been enabled on the socket), we begin to probe
 101  * the connection.  We force the peer to send us a segment by sending:
 102  *      <SEQ=SND.UNA-1><ACK=RCV.NXT><CTL=ACK>
 103  * This segment is (deliberately) outside the window, and should elicit
 104  * an ack segment in response from the peer.  If, despite the TCPT_KEEP
 105  * initiated segments we cannot elicit a response from a peer in TCPT_MAXIDLE
 106  * amount of time probing, then we drop the connection.
 107  */
 108
 109 #ifdef PRIVATE
 110
 111 /*
 112  * Time constants.
 113  */
 114 #define TCPTV_MSL       ( 30*PR_SLOWHZ)         /* max seg lifetime (hah!) */
 115 #define TCPTV_SRTTBASE  0                       /* base roundtrip time;
 116                                                    if 0, no idea yet */
 117 #define TCPTV_RTOBASE   (  3*PR_SLOWHZ)         /* assumed RTO if no info */
 118 #define TCPTV_SRTTDFLT  (  3*PR_SLOWHZ)         /* assumed RTT if no info */
 119
 120 #define TCPTV_PERSMIN   (  5*PR_SLOWHZ)         /* retransmit persistence */
 121 #define TCPTV_PERSMAX   ( 60*PR_SLOWHZ)         /* maximum persist interval */
 122
 123 #define TCPTV_KEEP_INIT ( 75*PR_SLOWHZ)         /* initial connect keep alive */
 124 #define TCPTV_KEEP_IDLE (120*60*PR_SLOWHZ)      /* dflt time before probing */
 125 #define TCPTV_KEEPINTVL ( 75*PR_SLOWHZ)         /* default probe interval */
 126 #define TCPTV_KEEPCNT   8                       /* max probes before drop */
 127
 128 #define TCPTV_MIN       (  1*PR_SLOWHZ)         /* minimum allowable value */
 129 #define TCPTV_REXMTMAX  ( 64*PR_SLOWHZ)         /* max allowable REXMT value */
 130
 131 #define TCPTV_TWTRUNC   8                       /* RTO factor to truncate TW */
 132
 133 #define TCP_LINGERTIME  120                     /* linger at most 2 minutes */
 134
 135 #define TCP_MAXRXTSHIFT 12                      /* maximum retransmits */
 136
 137 #define TCPTV_DELACK    PR_FASTHZ               /* 125ms timeout */
 138
 139 #ifdef  TCPTIMERS
 140 static char *tcptimers[] =
 141     { "REXMT", "PERSIST", "KEEP", "2MSL" };
 142 #endif
 143
 144 #ifdef KERNEL
 145 /*
 146  * Force a time value to be in a certain range.
 147  */
 148 #define TCPT_RANGESET(tv, value, tvmin, tvmax) do { \
 149         (tv) = (value); \
 150         if ((u_long)(tv) < (u_long)(tvmin)) \
 151                 (tv) = (tvmin); \
 152         else if ((u_long)(tv) > (u_long)(tvmax)) \
 153                 (tv) = (tvmax); \
 154 } while(0)
 155
 156 #define TCP_KEEPIDLE(tp) \
 157         (tp->t_keepidle && (tp->t_inpcb->inp_socket->so_options & SO_KEEPALIVE) ? \
 158                 tp->t_keepidle : tcp_keepidle)
 159
 160 extern int tcp_keepinit;                /* time to establish connection */
 161 extern int tcp_keepidle;                /* time before keepalive probes begin */
 162 extern int tcp_keepintvl;               /* time between keepalive probes */
 163 extern int tcp_maxidle;                 /* time to drop after starting probes */
 164 extern int tcp_delacktime;              /* time before sending a delayed ACK */
 165 extern int tcp_maxpersistidle;
 166 extern int tcp_msl;
 167 extern int tcp_ttl;                     /* time to live for TCP segs */
 168 extern int tcp_backoff[];
 169
 170 void    tcp_timer_2msl(void *xtp);
 171 void    tcp_timer_keep(void *xtp);
 172 void    tcp_timer_persist(void *xtp);
 173 void    tcp_timer_rexmt(void *xtp);
 174 void    tcp_timer_delack(void *xtp);
 175
 176 #endif /* KERNEL */
 177 #endif /* PRIVATE */
 178 #endif /* !_NETINET_TCP_TIMER_H_ */
 179