Centralize if queue handling.
[dragonfly.git] / sys / netproto / ns / spp_timer.h
1 /*
2  * Copyright (c) 1982, 1986, 1988, 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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)spp_timer.h 8.1 (Berkeley) 6/10/93
34  * $FreeBSD: src/sys/netns/spp_timer.h,v 1.9 1999/12/29 04:46:20 peter Exp $
35  * $DragonFly: src/sys/netproto/ns/spp_timer.h,v 1.2 2003/06/17 04:28:53 dillon Exp $
36  */
37
38 #ifndef _NETNS_SPP_TIMER_H_
39 #define _NETNS_SPP_TIMER_H_
40
41 /*
42  * Definitions of the SPP timers.  These timers are counted
43  * down PR_SLOWHZ times a second.
44  */
45 #define SPPT_NTIMERS    4
46
47 #define SPPT_REXMT      0               /* retransmit */
48 #define SPPT_PERSIST    1               /* retransmit persistance */
49 #define SPPT_KEEP       2               /* keep alive */
50 #define SPPT_2MSL       3               /* 2*msl quiet time timer */
51
52 /*
53  * The SPPT_REXMT timer is used to force retransmissions.
54  * The SPP has the SPPT_REXMT timer set whenever segments
55  * have been sent for which ACKs are expected but not yet
56  * received.  If an ACK is received which advances tp->snd_una,
57  * then the retransmit timer is cleared (if there are no more
58  * outstanding segments) or reset to the base value (if there
59  * are more ACKs expected).  Whenever the retransmit timer goes off,
60  * we retransmit one unacknowledged segment, and do a backoff
61  * on the retransmit timer.
62  *
63  * The SPPT_PERSIST timer is used to keep window size information
64  * flowing even if the window goes shut.  If all previous transmissions
65  * have been acknowledged (so that there are no retransmissions in progress),
66  * and the window is too small to bother sending anything, then we start
67  * the SPPT_PERSIST timer.  When it expires, if the window is nonzero,
68  * we go to transmit state.  Otherwise, at intervals send a single byte
69  * into the peer's window to force him to update our window information.
70  * We do this at most as often as SPPT_PERSMIN time intervals,
71  * but no more frequently than the current estimate of round-trip
72  * packet time.  The SPPT_PERSIST timer is cleared whenever we receive
73  * a window update from the peer.
74  *
75  * The SPPT_KEEP timer is used to keep connections alive.  If an
76  * connection is idle (no segments received) for SPPTV_KEEP amount of time,
77  * but not yet established, then we drop the connection.  If the connection
78  * is established, then we force the peer to send us a segment by sending:
79  *      <SEQ=SND.UNA-1><ACK=RCV.NXT><CTL=ACK>
80  * This segment is (deliberately) outside the window, and should elicit
81  * an ack segment in response from the peer.  If, despite the SPPT_KEEP
82  * initiated segments we cannot elicit a response from a peer in SPPT_MAXIDLE
83  * amount of time, then we drop the connection.
84  */
85
86 #define SPP_TTL         30              /* default time to live for SPP segs */
87 /*
88  * Time constants.
89  */
90 #define SPPTV_MSL       ( 15*PR_SLOWHZ)         /* max seg lifetime */
91 #define SPPTV_SRTTBASE  0                       /* base roundtrip time;
92                                                    if 0, no idea yet */
93 #define SPPTV_SRTTDFLT  (  3*PR_SLOWHZ)         /* assumed RTT if no info */
94
95 #define SPPTV_PERSMIN   (  5*PR_SLOWHZ)         /* retransmit persistance */
96 #define SPPTV_PERSMAX   ( 60*PR_SLOWHZ)         /* maximum persist interval */
97
98 #define SPPTV_KEEP      ( 75*PR_SLOWHZ)         /* keep alive - 75 secs */
99 #define SPPTV_MAXIDLE   (  8*SPPTV_KEEP)        /* maximum allowable idle
100                                                    time before drop conn */
101
102 #define SPPTV_MIN       (  1*PR_SLOWHZ)         /* minimum allowable value */
103 #define SPPTV_REXMTMAX  ( 64*PR_SLOWHZ)         /* max allowable REXMT value */
104
105 #define SPP_LINGERTIME  120                     /* linger at most 2 minutes */
106
107 #define SPP_MAXRXTSHIFT 12                      /* maximum retransmits */
108
109 #ifdef  SPPTIMERS
110 char *spptimers[] =
111     { "REXMT", "PERSIST", "KEEP", "2MSL" };
112 #endif
113
114 /*
115  * Force a time value to be in a certain range.
116  */
117 #define SPPT_RANGESET(tv, value, tvmin, tvmax) { \
118         (tv) = (value); \
119         if ((tv) < (tvmin)) \
120                 (tv) = (tvmin); \
121         else if ((tv) > (tvmax)) \
122                 (tv) = (tvmax); \
123 }
124
125 #ifdef _KERNEL
126 extern int spp_backoff[];
127 #endif
128
129 #endif