From Sven-Ola Tuecke <sven-ola@gmx.de>: add support for fixedpoint math
[olsrd.git] / src / hysteresis.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41
42 #include <time.h>
43
44 #include "olsr_protocol.h"
45 #include "hysteresis.h"
46 #include "defs.h"
47 #include "olsr.h"
48 #include "net_olsr.h"
49 #include "ipcalc.h"
50
51 #ifdef USE_FPM
52 #define hscaling ftofpm(olsr_cnf->hysteresis_param.scaling)
53 #define hhigh    ftofpm(olsr_cnf->hysteresis_param.thr_high)
54 #define hlow     ftofpm(olsr_cnf->hysteresis_param.thr_low)
55 #else
56 #define hscaling olsr_cnf->hysteresis_param.scaling
57 #define hhigh    olsr_cnf->hysteresis_param.thr_high
58 #define hlow     olsr_cnf->hysteresis_param.thr_low
59 #endif
60
61 #ifdef USE_FPM
62 fpm
63 olsr_hyst_calc_stability(fpm old_quality)
64 {
65   return fpmadd(fpmmul(fpmsub(itofpm(1), hscaling), old_quality), hscaling);
66 }
67 #else
68 float
69 olsr_hyst_calc_stability(float old_quality)
70 {
71   return (((1 - hscaling) * old_quality) + hscaling);
72 }
73 #endif
74
75
76
77 #ifdef USE_FPM
78 fpm
79 olsr_hyst_calc_instability(fpm old_quality)
80 {
81   return fpmmul(fpmsub(itofpm(1), hscaling), old_quality);
82 }
83 #else
84 float
85 olsr_hyst_calc_instability(float old_quality)
86 {
87   return ((1 - hscaling) * old_quality);
88 }
89 #endif
90
91
92
93 int
94 olsr_process_hysteresis(struct link_entry *entry)
95 {
96   clock_t tmp_timer;
97
98   //printf("PROCESSING QUALITY: %f\n", entry->L_link_quality);
99   if(entry->L_link_quality > hhigh)
100     {
101       if(entry->L_link_pending == 1)
102         {
103 #ifndef NODEBUG
104           struct ipaddr_str buf;
105 #endif
106           OLSR_PRINTF(1, "HYST[%s] link set to NOT pending!\n", 
107                       olsr_ip_to_string(&buf, &entry->neighbor_iface_addr));
108           changes_neighborhood = OLSR_TRUE;
109         }
110
111       /* Pending = false */
112       entry->L_link_pending = 0;
113
114       if(!TIMED_OUT(entry->L_LOST_LINK_time))
115         changes_neighborhood = OLSR_TRUE;
116
117       /* time = now -1 */
118       entry->L_LOST_LINK_time = now_times - 1;
119
120       return 1;
121     }
122
123   if(entry->L_link_quality < hlow)
124     {
125       if(entry->L_link_pending == 0)
126         {
127 #ifndef NODEBUG
128           struct ipaddr_str buf;
129 #endif
130           OLSR_PRINTF(1, "HYST[%s] link set to pending!\n", 
131                       olsr_ip_to_string(&buf, &entry->neighbor_iface_addr));
132           changes_neighborhood = OLSR_TRUE;
133         }
134       
135       /* Pending = true */
136       entry->L_link_pending = 1;
137
138       if(TIMED_OUT(entry->L_LOST_LINK_time))
139         changes_neighborhood = OLSR_TRUE;
140
141       /* Timer = min (L_time, current time + NEIGHB_HOLD_TIME) */
142       //tmp_timer = now;
143       //tmp_timer.tv_sec += NEIGHB_HOLD_TIME; /* Takafumi fix */
144       tmp_timer = now_times + get_hold_time_neighbor();
145
146         entry->L_LOST_LINK_time = 
147           entry->time > tmp_timer ? tmp_timer : entry->time;
148
149       /* (the link is then considered as lost according to section
150          8.5 and this may produce a neighbor loss).
151          WTF?
152       */
153       return -1;
154     }
155
156   /*
157    *If we get here then:
158    *(HYST_THRESHOLD_LOW <= entry->L_link_quality <= HYST_THRESHOLD_HIGH)
159    */
160
161   /* L_link_pending and L_LOST_LINK_time remain unchanged. */
162   return 0;
163
164
165 }
166
167 /**
168  *Update the hello timeout of a hysteresis link
169  *entry
170  *
171  *@param entry the link entry to update
172  *@param htime the hello interval to use
173  *
174  *@return nada
175  */
176 void
177 olsr_update_hysteresis_hello(struct link_entry *entry, double htime)
178 {
179 #ifndef NODEBUG
180   struct ipaddr_str buf;
181 #endif
182   OLSR_PRINTF(3, "HYST[%s]: HELLO update vtime %f\n", olsr_ip_to_string(&buf, &entry->neighbor_iface_addr), htime*1.5);
183   /* hello timeout = current time + hint time */
184   /* SET TIMER TO 1.5 TIMES THE INTERVAL */
185   /* Update timer */
186
187   entry->hello_timeout = GET_TIMESTAMP(htime*1500);
188
189   return;
190 }
191
192
193
194 void
195 update_hysteresis_incoming(union olsr_ip_addr *remote, struct interface *local, olsr_u16_t seqno)
196 {
197   struct link_entry *lnk = lookup_link_entry(remote, NULL, local);
198
199   /* Calculate new quality */
200   if(lnk != NULL)
201     {
202 #if !defined(NODEBUG) && defined(DEBUG)
203       struct ipaddr_str buf;
204 #endif
205       lnk->L_link_quality = olsr_hyst_calc_stability(lnk->L_link_quality);
206 #ifdef DEBUG
207       OLSR_PRINTF(3, "HYST[%s]: %s\n", olsr_ip_to_string(&buf, remote), olsr_etx_to_string(lnk->L_link_quality));
208 #endif
209
210       /* 
211        * see how many packets we have missed and update the link quality
212        * for each missed packet; HELLOs have already been accounted for by
213        * the timeout function and the number of missed HELLOs has already
214        * been added to olsr_seqno there
215        */
216
217       if (lnk->olsr_seqno_valid && 
218           (unsigned short)(seqno - lnk->olsr_seqno) < 100)
219           while (lnk->olsr_seqno != seqno)
220             {
221               lnk->L_link_quality = olsr_hyst_calc_instability(lnk->L_link_quality);
222 #ifdef DEBUG
223               OLSR_PRINTF(5, "HYST[%s] PACKET LOSS! %s\n",
224                           olsr_ip_to_string(&buf, remote), olsr_etx_to_string(lnk->L_link_quality));
225 #endif
226 #ifdef USE_FPM
227               if(lnk->L_link_quality < ftofpm(olsr_cnf->hysteresis_param.thr_low))
228 #else
229               if(lnk->L_link_quality < olsr_cnf->hysteresis_param.thr_low)
230 #endif
231                 break;
232
233               lnk->olsr_seqno++;
234             }
235
236
237       lnk->olsr_seqno = seqno + 1;
238       lnk->olsr_seqno_valid = OLSR_TRUE;
239
240       //printf("Updating seqno to: %d\n", lnk->olsr_seqno);
241     }
242   return;
243 }