2a645c97f6b1e7910800c48b32a688d410f2b794
[people/mcb30/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 <gpxe/timer.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 /* The theoretical minimum that the algorithm in stop_timer() can
40  * adjust the timeout back down to is seven ticks, so set the minimum
41  * timeout to at least that value for the sake of consistency.
42  */
43 #define MIN_TIMEOUT 7
44
45 /** List of running timers */
46 static LIST_HEAD ( timers );
47
48 /**
49  * Start timer
50  *
51  * @v timer             Retry timer
52  *
53  * This starts the timer running with the current timeout value.  If
54  * stop_timer() is not called before the timer expires, the timer will
55  * be stopped and the timer's callback function will be called.
56  */
57 void start_timer ( struct retry_timer *timer ) {
58         if ( ! timer_running ( timer ) )
59                 list_add ( &timer->list, &timers );
60         timer->start = currticks();
61
62         /* 0 means "use default timeout" */
63         if ( timer->min_timeout == 0 )
64                 timer->min_timeout = DEFAULT_MIN_TIMEOUT;
65         /* We must never be less than MIN_TIMEOUT under any circumstances */
66         if ( timer->min_timeout < MIN_TIMEOUT )
67                 timer->min_timeout = MIN_TIMEOUT;
68         /* Honor user-specified minimum timeout */
69         if ( timer->timeout < timer->min_timeout )
70                 timer->timeout = timer->min_timeout;
71
72         DBG2 ( "Timer %p started at time %ld (expires at %ld)\n",
73                timer, timer->start, ( timer->start + timer->timeout ) );
74 }
75
76 /**
77  * Start timer with a specified fixed timeout
78  *
79  * @v timer             Retry timer
80  * @v timeout           Timeout, in ticks
81  */
82 void start_timer_fixed ( struct retry_timer *timer, unsigned long timeout ) {
83         start_timer ( timer );
84         timer->timeout = timeout;
85 }
86
87 /**
88  * Stop timer
89  *
90  * @v timer             Retry timer
91  *
92  * This stops the timer and updates the timer's timeout value.
93  */
94 void stop_timer ( struct retry_timer *timer ) {
95         unsigned long old_timeout = timer->timeout;
96         unsigned long now = currticks();
97         unsigned long runtime;
98
99         /* If timer was already stopped, do nothing */
100         if ( ! timer_running ( timer ) )
101                 return;
102
103         list_del ( &timer->list );
104         runtime = ( now - timer->start );
105         timer->start = 0;
106         DBG2 ( "Timer %p stopped at time %ld (ran for %ld)\n",
107                timer, now, runtime );
108
109         /* Update timer.  Variables are:
110          *
111          *   r = round-trip time estimate (i.e. runtime)
112          *   t = timeout value (i.e. timer->timeout)
113          *   s = smoothed round-trip time
114          *
115          * By choice, we set t = 4s, i.e. allow for four times the
116          * normal round-trip time to pass before retransmitting.
117          *
118          * We want to smooth according to s := ( 7 s + r ) / 8
119          *
120          * Since we don't actually store s, this reduces to
121          * t := ( 7 t / 8 ) + ( r / 2 )
122          *
123          */
124         if ( timer->count ) {
125                 timer->count--;
126         } else {
127                 timer->timeout -= ( timer->timeout >> 3 );
128                 timer->timeout += ( runtime >> 1 );
129                 if ( timer->timeout != old_timeout ) {
130                         DBG ( "Timer %p timeout updated to %ld\n",
131                               timer, timer->timeout );
132                 }
133         }
134 }
135
136 /**
137  * Handle expired timer
138  *
139  * @v timer             Retry timer
140  */
141 static void timer_expired ( struct retry_timer *timer ) {
142         int fail;
143
144         /* Stop timer without performing RTT calculations */
145         DBG2 ( "Timer %p stopped at time %ld on expiry\n",
146                timer, currticks() );
147         list_del ( &timer->list );
148         timer->start = 0;
149         timer->count++;
150
151         /* Back off the timeout value */
152         timer->timeout <<= 1;
153         if ( timer->max_timeout == 0 ) /* 0 means "use default timeout" */
154                 timer->max_timeout = DEFAULT_MAX_TIMEOUT;
155         if ( ( fail = ( timer->timeout > timer->max_timeout ) ) )
156                 timer->timeout = timer->max_timeout;
157         DBG ( "Timer %p timeout backed off to %ld\n",
158               timer, timer->timeout );
159
160         /* Call expiry callback */
161         timer->expired ( timer, fail ); 
162 }
163
164 /**
165  * Single-step the retry timer list
166  *
167  * @v process           Retry timer process
168  */
169 static void retry_step ( struct process *process __unused ) {
170         struct retry_timer *timer;
171         struct retry_timer *tmp;
172         unsigned long now = currticks();
173         unsigned long used;
174
175         list_for_each_entry_safe ( timer, tmp, &timers, list ) {
176                 used = ( now - timer->start );
177                 if ( used >= timer->timeout )
178                         timer_expired ( timer );
179         }
180 }
181
182 /** Retry timer process */
183 struct process retry_process __permanent_process = {
184         .step = retry_step,
185 };