Towards an RFC2988-compliant timer.
[people/andreif/gpxe.git] / src / net / retry.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stddef.h>
20 #include <latch.h>
21 #include <gpxe/list.h>
22 #include <gpxe/process.h>
23 #include <gpxe/init.h>
24 #include <gpxe/retry.h>
25
26 /** @file
27  *
28  * Retry timers
29  *
30  * A retry timer is a binary exponential backoff timer.  It can be
31  * used to build automatic retransmission into network protocols.
32  *
33  * This implementation of the timer is designed to satisfy RFC 2988
34  * and therefore be usable as a TCP retransmission timer.
35  *
36  * 
37  */
38
39 /** Default timeout value */
40 #define MIN_TIMEOUT ( TICKS_PER_SEC / 4 )
41
42 /** Limit after which the timeout will be deemed permanent */
43 #define MAX_TIMEOUT ( 10 * TICKS_PER_SEC )
44
45 /* The theoretical minimum that the algorithm in stop_timer() can
46  * adjust the timeout back down to is seven ticks, so set the minimum
47  * timeout to at least that value for the sake of consistency.
48  */
49 #if MIN_TIMEOUT < 7
50 #undef MIN_TIMEOUT
51 #define MIN_TIMEOUT 7
52 #endif
53
54 /** List of running timers */
55 static LIST_HEAD ( timers );
56
57 /**
58  * Start timer
59  *
60  * @v timer             Retry timer
61  *
62  * This starts the timer running with the current timeout value.  If
63  * stop_timer() is not called before the timer expires, the timer will
64  * be stopped and the timer's callback function will be called.
65  */
66 void start_timer ( struct retry_timer *timer ) {
67         list_add ( &timer->list, &timers );
68         timer->start = currticks();
69         if ( timer->timeout < MIN_TIMEOUT )
70                 timer->timeout = MIN_TIMEOUT;
71 }
72
73 /**
74  * Stop timer
75  *
76  * @v timer             Retry timer
77  *
78  * This stops the timer and updates the timer's timeout value.
79  */
80 void stop_timer ( struct retry_timer *timer ) {
81         unsigned long old_timeout = timer->timeout;
82         unsigned long runtime;
83
84         list_del ( &timer->list );
85         runtime = currticks() - timer->start;
86
87         /* Update timer.  Variables are:
88          *
89          *   r = round-trip time estimate (i.e. runtime)
90          *   t = timeout value (i.e. timer->timeout)
91          *   s = smoothed round-trip time
92          *
93          * By choice, we set t = 4s, i.e. allow for four times the
94          * normal round-trip time to pass before retransmitting.
95          *
96          * We want to smooth according to s := ( 7 s + r ) / 8
97          *
98          * Since we don't actually store s, this reduces to
99          * t := ( 7 t / 8 ) + ( r / 2 )
100          *
101          */
102         if ( timer->count ) {
103                 timer->count--;
104         } else {
105                 timer->timeout -= ( timer->timeout >> 3 );
106                 timer->timeout += ( runtime >> 1 );
107                 if ( timer->timeout != old_timeout ) {
108                         DBG ( "Timer updated to %dms\n",
109                               ( ( 1000 * timer->timeout ) / TICKS_PER_SEC ) );
110                 }
111         }
112 }
113
114 /**
115  * Handle expired timer
116  *
117  * @v timer             Retry timer
118  */
119 static void timer_expired ( struct retry_timer *timer ) {
120         int fail;
121
122         /* Stop timer without performing RTT calculations */
123         list_del ( &timer->list );
124         timer->count++;
125
126         /* Back off the timeout value */
127         timer->timeout <<= 1;
128         if ( ( fail = ( timer->timeout > MAX_TIMEOUT ) ) )
129                 timer->timeout = MAX_TIMEOUT;
130         DBG ( "Timer backed off to %dms\n",
131               ( ( 1000 * timer->timeout ) / TICKS_PER_SEC ) );
132
133         /* Call expiry callback */
134         timer->expired ( timer, fail ); 
135 }
136
137 /**
138  * Single-step the retry timer list
139  *
140  * @v process           Retry timer process
141  */
142 static void retry_step ( struct process *process ) {
143         struct retry_timer *timer;
144         struct retry_timer *tmp;
145         unsigned long now = currticks();
146         unsigned long used;
147
148         list_for_each_entry_safe ( timer, tmp, &timers, list ) {
149                 used = ( now - timer->start );
150                 if ( used >= timer->timeout )
151                         timer_expired ( timer );
152         }
153
154         schedule ( process );
155 }
156
157 /** Retry timer process */
158 static struct process retry_process = {
159         .step = retry_step,
160 };
161
162 /** Initialise the retry timer module */
163 static void init_retry ( void ) {
164         schedule ( &retry_process );
165 }
166
167 INIT_FN ( INIT_PROCESS, init_retry, NULL, NULL );